写代码的目的是使代码更加清晰。 示例如下: 1.9.1 逗号、分号只在后面加空格。 逗号、分号只在后面加空格。 int a, b, c; 比较操作符, 赋值操作符"=" "+=", "="、 算术操作符"+" "%" 逻辑操作符"&;&;"、 , "+"、 "%", 逻辑操作符"&;&;" "&;" "&;&;"、 "&;", 1.9.2 比较操作符, 赋值操作符"="、 "+=", 算术操作符"+"、 , 位域操作符"<<" "^"等双目操作符的前后加空格 "<<"、 等双目操作符的前后加空格。 位域操作符"<<"、"^"等双目操作符的前后加空格。 if (current_time >= MAX_TIME_VALUE) { a = b + c; } a *= 2; a = b ^ 2; 1.9.3 "!"、"~"、"++"、"--"、"&;"(地址运算符)等单目操作符前后不加空格。 "!"、"~"、"++"、 --" "&;"(地址运算符)等单目操作符前后不加空格。 *p = 'a'; // 内容操作"*"与内容之间
flag = !isEmpty; // 非操作"!"与内容之间 p = &;mem; i++; // 地址操作"&;" 与内容之间 // "++","--"与内容之间
>"、"."前后不加空格 前后不加空格。 1.9.4 "->"、"."前后不加空格。 p->id = pid; // "->"指针前后不加空格
if、for、while、 等与后面的括号间应加空格, 等关键字更为突出、 1.9.5 if、for、while、switch 等与后面的括号间应加空格,使 if 等关键字更为突出、 明显。 明显。 if ((a >= b) &;&; (c > d))
2 注释格式约定
一般情况下, 2.1 一般情况下,源程序有效注释量必须在 20%以上。 %以上。
说明:注释的原则是有助于对程序的阅读理解,注释不宜太多也不能太少,注释语言必 须准确、易懂、简洁。
建议单行注释使用“//……” 多行注释使用“/* */” 2.2 建议单行注释使用“// ” 多行注释使用“/*……*/” , */ 。
说明:为了注释格式的统一
,一般情况下均采用“//……”的注释格式。
第 3页
武汉华工赛百数据系统有限公司 Central-China Cyber Data System Co., Ltd.
2.3
说明性文件(如头文件 文件、 文件、 文件、编译说明文件.cfg 等) 说明性文件(如头文件.h 文件、.inc 文件、.def 文件、编译说明文件 头部应进行注释,注释必须列出:版权说明、文件名、作者、版本号、 头部应进行注释,注释必须列出:版权说明、文件名、作者、版本号、创建日 功能描述、与其它文件的关系、修改日志等, 期、功能描述、与其它文件的关系、修改日志等,头文件的注释中还应有函数 功能简要说明。 功能简要说明。
示例:下面这段头文件的头注释比较标准。 //////////////////////////////////////////////////////////////// //版权所有(C), 1999-2002, 武汉华工赛百数据
系统有限公司 //文件名: //作者: //版本号: //创建日期: //功能描述: // //备注: //修改日志: // // // // // 1. 修改日期: 修改者: 修改原因: 修改内容: 2. ... Global.h Tomas 1.00 2002-2-4 用于详细说明此程序文件完成的主要功能,与其它类之间的依赖关 系等 其它内容的说明
///////////////////////////////////////////////////////////////
源文件头部应进行注释,列出:
版权说明、文件名、作者、版本号、创建日期、 2.4 源文件头部应进行注释,列出:版权说明、文件名、作者、版本号、创建日期、 模块描述、修改日志等。 模块描述、修改日志等。
示例:下面这段源文件的头注释比较标准。 /////////////////////////////////////////////////////////////// //版权所有(C), 1999-2002, 武汉华工赛百数据系统有限公司 //文件名: //作者: //版本号: //创建日期: //模块描述: //备注: //修改日志: // // // 1. 修改日期: 修改者: 修改原因:
第 4页
Global.cpp Tomas 1.00 2002-2-4 描述本文件内部各模块之间的关系以及与其它文件之间的接口等 其它内容的说明
武汉华工赛百数据系统有限公司 Central-China Cyber Data System Co., Ltd.
// //
修改内容: 2. ...
///////////////////////////////////////////////////////////////
函数头部应进行注释,列出:函数名称、作