Which C# XML documentation comment tag is used for the literals true
, false
and null
?
In Microsoft's own documentation, these literals appear in bold text . For example, the documentation for the property ArrayList.IsFixedSize appears as:
true if the ArrayList has a fixed size; otherwise, false . The default is false .
None of Microsoft's Recommended Tags seem to apply to this situation. The best fit appears to be <c> , however <c>true</c>
appears as true
when the documentation is rendered by Doxygen .
However, using <b>true</b>
with Doxygen yielded bold text as I surmised that it might. But that leaves me wondering about the portability of using standard HTML tags with other documentation generation tools such as Sandcastle and GhostDoc .
您应该使用<see langword="true"/>
条目,以便它适用于正在使用的任何语言。
Per GhostDoc's behavior, <c>true</c>
is the correct answer. I've voted up saravanan's comment now that I've been able to confirm it.
The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.