引用:http://fanlynn.blog.hexun.com/22181090_d.html
模块(类)注释规范
文件头部注释
在代码文件的头部进行注释,这样做的好处在于,我们能对代码文件做变更跟踪。在代码头部分标注出创始人、创始时间、修改人、修改时间、代码的功能,这在团队开发中必不可少,它们可以使后来维护/修改的同伴在遇到问题时,在第一时间知道他应该向谁去寻求帮助,并且知道这个文件经历了多少次迭代、经历了多少个程序员的开发和修改。
样本:
/********************************************************************************
** 作者: Eunge
** 创始时间:2004-6-8
** 修改人:Lucy
** 修改时间:2004-12-9
** 修改人:Lucy
** 修改时间:2005-01-29
** 描述:
** 主要用于产品信息的资料录入,…
*********************************************************************************/
模块开始必须以以下形式书写模块注释:
///
///模块编号:<模块编号,可以引用系统设计中的模块编号>
///作用:<对此类的描述,可以引用系统设计中的描述>
///作者:作者中文名
///编写日期:<模块创建日期,格式:YYYY-MM-DD>
///
如果模块有修改,则每次修改必须添加以下注释:
///
///Log编号:<log< SPAN="">编号,从1开始一次增加>
///修改描述:<对此修改的描述>
///作者:修改者中文名
///修改日期:<模块修改日期,格式:YYYY-MM-DD>
///
3.2.2. 类属性注释规范
在类的属性必须以以下格式编写属性注释:
///
///属性说明
///
3.2.3. 方法注释规范
在类的方法声明前必须以以下格式编写注释
///
/// 说明:<对该方法的说明>
///
///<参数说明>
///
///<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义>
///
3.2.4. 代码间注释规范
代码间注释分为单行注释和多行注释:
单行注释:
//<单行注释>
多行注释:
/*多行注释1
多行注释2
多行注释3*/
代码中遇到语句块时必须添加注释(if,for,foreach,……),添加的注释必须能够说明此语句块的作用和实现手段(所用算法等等)。