什么是C#文档标签？

Question

什么是C#文档标签？

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

Answer 1

如果您在方法或类的上方键入此内容,intellisense应提示您可用标记的列表:

/// <

Run Code Online (Sandbox Code Playgroud)

Answer 2

Kev*_*ger 13

这是一个清单:

摘要
PARAM
回报
例
码
看到
也可以看看
名单
值
文件
版权

这是一个例子:

<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>

c#没有作者标签 (6认同)
@KevinDriedger 是的，谢谢！现在更准确了。我不想推送它（如果不是太大的干预，我会自己编辑你的答案），但如果它包含[指向 MSDN 推荐的文档标签页面的链接](https://learn .microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/recommended-tags-for-documentation-comments），并在此处提及所有存在的标签（例如此处缺少的“权限”，与那里不存在“版权”）-恕我直言，这将是巨大的改进。 (2认同)

Answer 3

Dav*_*dro 9

查看有关各种C#XML文档标记的精彩文档.(转到底部查看标签)

唉,该域已过期,这是一个断开的链接. (8认同)
我假设当你将它发布到网页时就像JavaDocs一样.更新更新链接:http://msdn.microsoft.com/en-us/library/b2s063f7.aspx (2认同)

归档时间：	17 年，3 月前
查看次数：	29492 次
最近记录：	7 年，11 月前