1 排版
1-1:程序块要采用缩进风格编写,缩进的空格数为4个。(规定)
说明:对于由开发工具自动生成的代码可以有不一致。
1-2:不允许把多个短语句写在一行中,即一行只写一条语句。(强烈建议)
示例:如下例子不符合规范。
rect.length = 0; rect.width = 0;
应如下书写
rect.length = 0;
rect.width = 0;
注:nop()函数可以一行写多个,但最多不要超过5个。
1-3:if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。示例:如下例子不符合规范。(规定)
if (pUserCR == NULL) return;
应如下书写:
if (pUserCR == NULL)
{
return;
}
1-4:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。(规定)
说明:采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格。
在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。
示例:
(1) 逗号、分号只在后面加空格。
int a, b, c;
(2)比较操作符, 赋值操作符"="、 “+=”,算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^“等双目操作符的前后加空格。
if (current_time>= MAX_TIME_VALUE)
a = b + c;
a *= 2;
a = b ^ 2;
(3)”!"、"~"、"++"、"–"、"&"(地址运算符)等单目操作符前后不加空格。
p = ‘a’; // 内容操作"“与内容之间
flag = !isEmpty; // 非操作”!“与内容之间
p = &mem; // 地址操作”&" 与内容之间
i++; // “++”,"–“与内容之间
(4)”->"、"."前后不加空格。
p->id = pid; // "->"指针前后不加空格
(5) if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显。
if (a >= b && c > d)
2 注释
2-1:一般情况下,源程序有效注释量必须在20%以上。
说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。
2-2:说明性文件(如头文件.h文件、说明文件.txt等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、接口、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。(规定)
示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/*************************************************
Copyright ©, 2010-2030, Risecomm Micro. Co., Ltd.
File name: // 文件名
Author: Version: Date: // 作者、版本及完成日期
Description: // 用于详细说明此程序文件完成的主要功能,与其他模块
// 或函数的接口,输出值、取值范围、含义及参数间的控
// 制、顺序、独立或依赖等关系
Others: // 其它内容的说明
History: // 修改历史记录列表,每条修改记录应包括修改日期、修改
// 者及修改内容简述
…………
*************************************************/
/**********************************************************************************************************
Copyright ©, 2010-2030, Risecomm Micro. Co., Ltd.
Filename: xxxxx.h
Author: Version: Date:
Description:
Others:
History