35

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

4

7 答案 7

15

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

/// <
于 2008-09-15T19:34:58.987 回答
14

这是一个列表:

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

这是一个例子:

<文件>
<copyright>(c) Extreme Designers Inc. 2008.</copyright>
<datecreated>2008-09-15</datecreated>
<摘要>
这是我的总结
</总结>
<备注>
<para><see cref="TextReader"/> 可以通过以下方式使用:</para>
<list type="数字">
<item>第一项</item>
<item>第二项</item>
</列表>
</备注>
<示例>
<代码>
System.Console.WriteLine("Hello, World");
</代码>
</示例>
<param name="aParam">我的第一个参数</param>
<returns>代表摘要的对象</returns>
</文件>
于 2008-09-15T19:47:45.277 回答
8

查看有关各种 C# XML 文档标签的优秀文档。(转到底部查看标签)

于 2008-09-15T19:31:37.950 回答
4

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

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

于 2008-09-15T19:31:13.740 回答
3

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

于 2008-09-15T19:33:30.350 回答
2

请参阅此处的出色 MSDN 文章作为您的第一站。

于 2008-09-15T19:31:50.400 回答
1

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

于 2008-09-15T19:52:39.007 回答