为C#预处理程序写注释吗?

时间:2018-07-31 08:43:00

标签: c# comments preprocessor

我正在为Unity 3D编写脚本,并且已经/想要使用一些预处理器。

例如,VisualStudio总是通过一些警告,例如

  

字段'foo'从未分配,并且将始终具有其默认值     值'null'(CS0649)(Assembly-CSharp)

对于类似

的代码
puclic class Example : MonoBehvaiour
{
    [SerializedField]
    private GameObject exampleObject;

    ...
}

尽管课程范围将在Unity编辑器的检查器中设置。

此外,我从未在此类中使用字段 ,但在需要该字段的地方写了CustomEditor。所以我也会收到其他类似的警告

  

已声明但未使用的变量。   
已分配变量但未使用。   
已分配但未使用的私有字段。

因此,在确保代码正确且不需要那些警告之后,我决定遵循thisthis post并使用一些预处理器,例如

#pragma warning disable 0414
#pragma warning disable 0649

    // some fields here

#pragma warning restore 0414
#pragma warning restore 0649

现在我的问题:

我如何为预处理器添加注释?
可惜的是,不仅有这样的东西

#comment "some comment here"

这似乎不是真正的意图/思想,但我真的很想这样做,以便让我的同事知道预处理器的优点/用途。


当然我可以添加注释,但是注释不适合预处理程序,而可以使用常规代码,例如

    // This silences "private field assigned but not used." warnings
#pragma warning disable 0414

    // flag to look for unsaved changes
    private bool _unsavedChanges = false;

    // This re-enables "private field assigned but not used" warnings
#pragma warning restore 0414

这使它看起来很混乱,而不是澄清事物,并且注释似乎不是/“属于”预处理器,而是正常的代码。


注意:
我不想只是针对文件或项目禁用警告!
这些例子并不是我唯一想为其添加注释的预处理器。

0 个答案:

没有答案