C# 类库中添加注释方法

C# 类库中添加注释方法

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文档文件选中再编译

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

转载自：http://www.cnblogs.com/cx361/archive/2011/12/21/2296503.html