C# 注释（Comment）规范
注释规范包括：模块（类）注释规范、类的属性、方法注释规范、代码间注释
1.模块（类）注释规范
模块开始必须以以下形式书写模块注释：
///
///模块编号： ///作用： ///作者：作者中文名
///编写日期： /// 如果模块有修改，则每次修改必须添加以下注释：
/// ///Log编号：
///修改描述： ///作者：修改者中文名
///修改日期： ///
2.类属性注释规范
在类的属性必须以以下格式编写属性注释：
/// ///属性说明 ///
3.方法注释规范
在类的方法声明前必须以以下格式编写注释
/// /// 说明：
/// /// /// /// ///
4.代码间注释规范
代码间注释分为单行注释和多行注释：
单行注释： //
多行注释： /*多行注释1 多行注释2 多行注释3*/
代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。
详细介绍见：
http://www.daodoc.com/
《C# 注释规范.doc》
将本文的Word文档下载到电脑，方便编辑。
推荐度：
点击下载文档