什么是C＃文档标签？

Question

在C＃文档标签中，您可以生成类似于MSDN的输出。什么是在类，方法和属性上面的///（三次斜杠）注释区域内使用的允许标记列表？

Answer 1

如果您在方法或类的上方输入此内容，intellisense应提示您提供可用标记列表：

/// <

Answer 2

这是一个清单：

• 摘要
• 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 3

查看Great documentation on the various C# XML documentation tags.（转到底部查看标签）

Answer 4

2002年MSDN文章详细介绍了所有标签以及何时使用它们：

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

Answer 5

GhostDoc有助于为您的方法/类创建存根注释。

Answer 6

请参阅优秀的MSDN文章here作为您的第一站。

Answer 7

查看Sandcastle的文档。这是.NET的新文档标准。