什么是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的新文档标准。