[英]Which C# XML documentation comment tag is used for 'true', 'false' and 'null'?
哪个 C# XML 文档注释标记用于文字true
、 false
和null
?
在 Microsoft 自己的文档中,这些文字以粗体显示。 例如,属性ArrayList.IsFixedSize的文档显示为:
如果ArrayList具有固定大小,则为true ; 否则为false 。 默认值为false 。
Microsoft 的推荐标签似乎都不适用于这种情况。 最合适的似乎是<c> ,但是<c>true</c>
在文档由Doxygen呈现时显示为true
。
但是,将<b>true</b>
与 Doxygen 结合使用会产生粗体文本,正如我猜测的那样。 但这让我想知道将标准 HTML 标记与其他文档生成工具(如Sandcastle和GhostDoc )一起使用的可移植性。
您应该使用<see langword="true"/>
条目,以便它适用于正在使用的任何语言。
根据 GhostDoc 的行为, <c>true</c>
是正确答案。 既然我已经能够确认它,我已经投票支持了 saravanan 的评论。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.