哪个C#xml文档注释标记用于'true','false'和'null'?

问题描述 投票:29回答:2

哪个C#xml文档注释标记用于文字truefalsenull

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

如果ArrayList具有固定大小,则为true;否则,错误。默认值为false。

没有Microsoft's Recommended Tags似乎适用于这种情况。最合适的似乎是<c>,但<c>true</c>true提供文档时显示为Doxygen

然而,使用带有Doxygen的<b>true</b>产生了大胆的文字,因为我猜测它可能。但这让我想知道使用标准HTML标签与其他文档生成工具(如SandcastleGhostDoc)的可移植性。

c# styles literals xml-documentation
2个回答
17
投票

根据GhostDoc的行为,<c> true </ c>是正确的答案。我已经投了saravanan的评论,因为我已经能够确认它。


5
投票

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

© www.soinside.com 2019 - 2024. All rights reserved.