[ZT]C#中XML格式注释

coding的时候,常常涉及代码注释,常见的注释包括两类:
1)单行注释。格式:// comments
2)多行注释。格式:/* comments... */
c#引入了新的xml注释,即我们在某个函数前新起一行,输入///,vs.net会自动增加xml格式的注释,这里整理一下可用的xml注释。
xml注释分为一级注释(primary tags)和二级注释(secondary tags),前者可以单独存在,后者必须包含在一级注释内部。
i 一级注释
1. <remarks>对类型进行描述,功能类似<summary>,据说建议使用<remarks>;
2. <summary>对共有类型的类、方法、属性或字段进行注释;
3. <value>主要用于属性的注释,表示属性的制的含义,可以配合<summary>使用;
4. <param>用于对方法的参数进行说明,格式:<param name="param_name">value</param>;
5. <returns>用于定义方法的返回值,对于一个方法,输入///后,会自动添加<summary>、<param>列表和<returns>;
6. <exception>定义可能抛出的异常,格式:<exception cref="idnotfoundexception">;
7. <example>用于给出如何使用某个方法、属性或者字段的使用方法;
8. <permission>涉及方法的访问许可;
9. <seealso>用于参考某个其它的东东:),也可以通过cref设置属性;
10. <include>用于指示外部的xml注释;
ii 二级注释
1. <c> or <code>主要用于加入代码段;
2. <para>的作用类似html中的<p>标记符,就是分段;
3. <pararef>用于引用某个参数;
4. <see>的作用类似<seealso>,可以指示其它的方法;
5. <list>用于生成一个列表;
另外,还可以自定义xml标签。
呵呵,通过在工程的属性中设置 xml documentation file的文件名,即可生成xml格式的文件。
另外还有一个有用的工具叫ndoc,可以根据这些注释生成帮助文件,很好使。但是好像不支持vs.net 2005。

你可能感兴趣的:(xml)