C#怎么动态生成方法和Summary注释

C#中新建的类库添加注释时，应注意以下问题：

1、编译动态类库时命名空间要规范，一般不要和类同名，命名空间一般定义格式：项目名+类文件名；

2、动态类库中，类、方法的注释都采用下列方式注释：

类注释的格式：

///

<summary>

///

文件名:Ini处理类/

///

文件功能描述:读写Ini文件/

///

版权所有:Copyright

(C)

ZGM/

///

创建标识:2011.12.13/

///

修改标识:/

///

修改描述:/

///

</summary>

方法注释的格式：

///

<summary>

///

读出Ini文件

///

</summary>

///

<param

name="Section">Ini文件中的段落名称</param>

///

<param

name="Key">Ini文件中的关键字</param>

///

<param

name="IniFilePath">Ini文件的完整路径和名称</param>

///

<returns>Ini文件中关键字的数值</returns>

3、生成与动态类库相同名称的xml文件，具体设置是：项目右键—>属性—>生成—>XML文档文件选中再编译

4、引用动态类库时，把类库和同名的xml文件放到同一个文件夹内即可。

C# 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标签

---