[英]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.