什么是C#文档标签?

时间:2020-03-05 18:54:18  来源:igfitidea点击:

在Cdocumentation标签中,我们可以产生类似于MSDN的输出。在类,方法和属性上方的///(三斜杠)注释区域内可使用的允许标签的列表是什么?

解决方案

回答

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

http://msdn.microsoft.com/zh-CN/magazine/cc302121.aspx

回答

查阅有关各种CXML文档标签的出色文档。 (转到底部以查看标签)

回答

首先,请参见此处的MSDN优秀文章。

回答

GhostDoc通过为方法/类创建存根注释来提供帮助。

回答

如果在方法或者类上方键入此内容,则intellisense应该提示我们可用标签列表:

/// <

回答

以下是清单:

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

这是一个例子:

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

回答

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