什麼是C＃文檔標籤？

Question

在C＃文檔標籤中，您可以生成類似於MSDN的輸出。什麼是在類，方法和屬性之上的///（三斜槓）註釋區域內使用的允許標記的列表？

從2002年

Answer 1

退房Great documentation on the various C# XML documentation tags.（轉到底部看到標籤）

Answer 2

MSDN文章詳細介紹所有的標籤和使用時機：

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 3

看到優秀的MSDN文章here作爲您的第一站。

Answer 4

GhostDoc通過爲您的方法/類創建存根評論來幫助您。

Answer 5

如果鍵入這只是上述的方法或類，智能感知應提示您提供標籤的列表：

/// < 

Answer 6

這裏有一個列表：

• 總結
• PARAM
• 返回
• 示例
• 代碼
• 看
• seealso
• 列表
• 值
• 文件
• 版權

下面是一個例子：

 
<file> 
<copyright>(c) Extreme Designers Inc. 2008.</copyright> 
<datecreated>2008-09-15</datecreated> 
<summary> 
Here's my summary 
</summary> 
<remarks> 
<para>The <see cref="TextReader"/> can be used in the following ways:</para> 
<list type="number"> 
<item>first item</item> 
<item>second item</item> 
</list> 
</remarks> 
<example> 
<code> 
System.Console.WriteLine("Hello, World"); 
</code> 
</example> 
<param name="aParam">My first param</param> 
<returns>an object that represents a summary</returns> 
</file> 

Answer 7

查找的文檔爲的內部。這是.NET的新文檔標準。