哪个 C# XML 文档注释标记用于“true”、“false”和“null”？

Posted 2023-02-22

【中文标题】哪个 C# XML 文档注释标记用于“true”、“false”和“null”？

【英文标题】：Which C# XML documentation comment tag is used for 'true', 'false' and 'null'?

【发布时间】：2014-02-14 15:42:02

【问题描述】：

哪个 C# XML 文档注释标记用于文字 true、false 和 null？

在 Microsoft 自己的文档中，这些文字以粗体文本显示。例如，ArrayList.IsFixedSize 属性的文档显示为：

true 如果ArrayList 具有固定大小；否则，错误。默认为 false。

Microsoft's Recommended Tags 似乎都不适用于这种情况。最合适的似乎是 <c>，但是当文档由 Doxygen 呈现时，<c>true</c> 显示为 true。

但是，将<b>true</b> 与 Doxygen 一起使用会产生粗体文本，正如我猜测的那样。但这让我想知道使用标准 HTML 标记的可移植性与其他文档生成工具（例如 Sandcastle 和 GhostDoc）。

【问题讨论】：

我将 用于所有布尔值，我们遵循的标准是什么来表示 cmets 中的布尔值。

你也可以使用例如<see langword="true">。但它对我来说不是粗体（我使用 Sandcastle），字体是蓝色的。

另见***.com/a/693227/492langword

@fedab 你忘了/: <see langword="true"/>

【参考方案1】：

根据 GhostDoc 的行为，<c>true</c> 是正确答案。既然我已经能够确认，我已经投票赞成 saravanan 的评论。

【参考方案2】：

您应该使用<see langword="true"/> 条目，以便它适用于所使用的任何语言。