C# 注释（Comment）规范

C# 注释（Comment）规范

1. 模块（类）注释规范

模块开始必须以以下形式书写模块注释：

///<summary>

         ///模块编号：<模块编号，可以引用系统设计中的模块编号>

         ///作用：<对此类的描述，可以引用系统设计中的描述>

         ///作者：作者中文名

         ///编写日期：<模块创建日期，格式：YYYY-MM-DD>

         ///</summary>

如果模块有修改，则每次修改必须添加以下注释：

         ///<summary>

         ///Log编号：<Log编号,从1开始一次增加>

         ///修改描述：<对此修改的描述>

         ///作者：修改者中文名

         ///修改日期：<模块修改日期，格式：YYYY-MM-DD>

         ///</summary>

2. 类属性注释规范

在类的属性必须以以下格式编写属性注释：

         ///<summary>

         ///属性说明

///</summary>

3. 方法注释规范

在类的方法声明前必须以以下格式编写注释

         ///<summary>

         ///说明：<对该方法的说明>

          ///</summary>

         ///<paramname="<参数名称>"><参数说明></param>

         ///<returns>

         ///<对方法返回值的说明，该说明必须明确说明返回的值代表什么含义>

         ///</returns>