认识XML文档注释的标记
2008-01-08 23:26
253 查看
在编写代码时,为类型以及类型的成员添加文档注释是一个好的习惯。C#以及其他.NET语言的编译器能够将文档注释处理成一个XML文件,再利用一些工具(如Sandcastle和已经死去的NDoc),还能把文档注释制作成帮助文档。所以,有必要学习一下文档注释推荐使用的标记。
理论上,可以使用任意的标记,不过在MSDN中,推荐使用以下的文档注释标记:
<c>
<code>
<example>
<exception>
<include>
<list>
<para>
<param>
<paramref>
<permission>
<remarks>
<returns>
<see>
<seealso>
<summary>
<typeparam>
<typepraramref>
<value>
有些标记比较简单,可能已经被大家所熟悉和使用了,比如<summary>。而且如果使用了开发工具的话(如Visual Studio),还能自动生成标记以及属性,非常方便。
除了这些标记之外,其他语言,如VB.NET,和一些文档生成工具,如NDoc和Sandcastle等,还补充了一些标记:
<event>
<exclude>
<filterpriority>
<note>
<overloads>
<preliminary>
<threadsafety>
这些补充的标记能够帮助文档生成工具在生成文档的时候,提供更丰富的内容。
参考资料:
MSDN:Recommended Tags for Documentation Comments
XML Documentation Comments Guide
理论上,可以使用任意的标记,不过在MSDN中,推荐使用以下的文档注释标记:
<c>
<code>
<example>
<exception>
<include>
<list>
<para>
<param>
<paramref>
<permission>
<remarks>
<returns>
<see>
<seealso>
<summary>
<typeparam>
<typepraramref>
<value>
有些标记比较简单,可能已经被大家所熟悉和使用了,比如<summary>。而且如果使用了开发工具的话(如Visual Studio),还能自动生成标记以及属性,非常方便。
除了这些标记之外,其他语言,如VB.NET,和一些文档生成工具,如NDoc和Sandcastle等,还补充了一些标记:
<event>
<exclude>
<filterpriority>
<note>
<overloads>
<preliminary>
<threadsafety>
这些补充的标记能够帮助文档生成工具在生成文档的时候,提供更丰富的内容。
参考资料:
MSDN:Recommended Tags for Documentation Comments
XML Documentation Comments Guide
相关文章推荐
- C#中的XML文档注释-推荐的文档注释标记
- Eclipse中添加文档注释快捷键与导入模板文件codetemplates.xml
- 把 Visual Studio .NET 源代码文件中C# XML注释提取成工程文档
- 通过设置项目输出XML文档,来强制要求写注释
- 使用.NET中的XML注释(二) -- 创建帮助文档入门篇
- xml中出现“文档中根元素后面的标记必须格式正确。”的错误
- 通过设置项目输出XML文档,来强制要求写注释
- 把 Visual Studio .NET 源代码文件中C# XML注释提取成工程文档
- C# XML 文档注释文件格式
- javadoc中文档注释标记的使用
- 通过代码XML注释与Sandcastle生成SDK文档(进阶篇)
- VS2005 XML注释生成XML文档文件
- .NET中的XML注释(二) 创建帮助文档
- C# XML文档注释
- XML文档标记
- power designer中如何给导出的xml文档添加注释功能
- 使用XSL将XML文档中的CDATA注释输出为HTML文本
- Visual Studio 2008(C#)XML注释提取成帮助文档的方法
- PHP 注释文档标记
- Java框架组件-XML、JSON解析,日志,测试,文档,注释