i++,j++)
{
...//programcode
}
2.5长参数
若函数或过程中的参数较长,则要进行适当的划分。
示例:
n7stat_str_compare((BYTE*)&stat_object,
(BYTE*)&(act_task_table[taskno].stat_object),
sizeof(_STAT_OBJECT));
n7stat_flash_act_duration(stat_item,frame_id*STAT_TASK_CHECK_NUMBER
+index,stat_object);
2.6短语句
不允许把多个短语句写在一行中,即一行只写一条语句。
示例:
如下例子不符合规范。
rect.length=0;rect.width=0;
应如下书写
rect.length=0;
rect.width=0;
2.7条件、循环语句
if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。
示例:
如下例子不符合规范。
if(pUserCR==NULL)return;
应如下书写:
if(pUserCR==NULL)
{
return;
}
2.8语句对齐
对齐只使用空格键,不使用TAB键。
说明:
以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐,
不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键,因此使用BC合入的版本大多会将缩进变乱。
2.9函数、过程和结构等语句块
函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。
2.10程序块分界符
程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。
在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
示例:
如下例子不符合规范。
for(...){
...//programcode
}
if(...)
{
...//programcode
}
voidexample_fun(void)
{
...//programcode
}
应如下书写。
for(...)
{
...//programcode
}
if(...)
{
...//programcode
}
voidexample_fun(void)
{
...//programcode
}
2.11操作符前后空格
在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。
说明:
采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C++语言中括号已经是最清晰的标志了。
在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。
给操作符留空格时不要连续留两个以上空格。
示例:
(1)逗号、分号只在后面加空格。
inta,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.12其他
2.12.1一行程序以小于80字符为宜,不要写得过长。
3注释
3.1有效注释量
一般情况下,源程序有效注释量必须在20%以上。
说明:
注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不
能太少,注释语言必须准确、易懂、简洁。
3.2公司标识
在头文件中加入公司标识。
示例如下:
**************************************************************************/
/* */
/*Copyright(c)1996-1998 XXXXXXCompany */
/* xxxxxxxx 版权所有1996-1998 */
/* */
/*PROPRIETARYRIGHTSof XXXXXXCompany areinvolvedinthe */
/*subject matterofthismaterial. Allmanufacturing,reproduction,use,*/
/*and salesrightspertainingtothissubjectmatteraregovernedbythe */
/*licenseagreement. Therecipientofthissoftwareimplicitlyaccepts*/
/*thetermsofthelicense. */
/*本软件文档资料是xxx公司的资产,任何人士阅读和使用本资料必须获得 */
/*相应的书面授权,承担保密责任和接受相应的法律约束. */
/* */
/**************************************************************************/
3.3说明性文件
说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:
版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
示例:
下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/*************************************************
Copyright(C)