C# 文档标签是什么？[关闭]

StackOverflow https://stackoverflow.com/questions/65969

  •  09-06-2019
  •  | 
  •  

题

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

有帮助吗？

解决方案

查看 有关各种 C# XML 文档标签的精彩文档。 （到底部查看标签）

其他提示

如果您在方法或类上方键入此内容，智能感知应提示您提供可用标签列表：

/// <

这是一个列表：

  • 概括
  • 参数
  • 回报
  • 例子
  • 代码
  • 看
  • 也可以看看
  • 列表
  • 价值
  • 文件
  • 版权

这是一个例子：

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

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

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

幽灵文档 通过为您的方法/类创建存根注释来提供帮助。

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

在文档中查找 沙堡. 。这是 .NET 的新文档标准。

许可以下： CC-BY-SA 和 归因
不隶属于 StackOverflow
scroll top