代码注释规范

源文件注释规范

/*********************************************************
** 文件名:
** Copyright (c) 2005 - 2006 ******* 软件项目开发部门
** 文件编号:
** 创 建 人:
** 日     期:
** 修 改 人:
** 日     期:
** 描     述:
**********************************************************/

类注释规范

/*********************************************************
** 类 编 号:<类编号，可以引用系统设计中的类编号>
** 作     用:<对此类的描述，可以引用系统设计中的描述>
** 作     者:作者中文名
** 编写日期:<类创建日期， 格式:YYYY-MM-DD>
**********************************************************/

类属性注释规范

//
//属性说明
//

方法注释规范

/*********************************************************
** 函 数 名:
** 功能描述:
** 输入参数: a - 类型 <说明>
                        b - 类型 <说明>
** 输出参数: x - 类型 <说明>
** 返 回 值: - 类型 <说明>
** 作     者:<创建人>
** 日     期:
** 修     改:<修改人>
** 日     期:
**********************************************************/

代码间注释规范

//
//<注释>
//