C语言常用的编程规范

2017-12-31 14:16:20来源:cnblogs.com作者:扶桑树的千年叶人点击

分享

1排版

1-1相对独立的程序块之间、变量说明之后必须加空行。
示例:如下例子不符合规范。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
1-2:较长的语句(>80 字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,
操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
示例:
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN

  • STAT_SIZE_PER_FRAM * sizeof( _UL );
    act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied
    = stat_poi[index].occupied;
    act_task_table[taskno].duration_true_or_false
    = SYS_get_sccp_statistic_state( stat_item );
    report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)
    && (n7stat_stat_item_valid (stat_item))
    && (act_task_table[taskno].result_data != 0));
    1-3:不允许把多个短语句写在一行中,即一行只写一条语句。
    示例:如下例子不符合规范。
    rect.length = 0; rect.width = 0;
    应如下书写
    rect.length = 0;
    rect.width = 0;
    1-4: if、 for、 do、 while、 case、 switch、 default 等语句自占一行,且 if、 for、 do、 while
    等语句的执行语句部分无论多少都要加括号{}。
    示例:如下例子不符合规范。
    if (pUserCR == NULL) return;
    应如下书写:
    if (pUserCR == NULL)
    {
    return;
    }
    1-5:对齐只使用空格键,不使用 TAB 键。
    说明:以免用不同的编辑器阅读程序时,因 TAB 键所设置的空格数目不同而造成程序布局
    不整齐,不要使用 BC 作为编辑器合版本,因为 BC 会自动将 8 个空格变为一个 TAB 键,
    因此使用 BC 合入的版本大多会将缩进变乱。
    1-6:程序块的分界符(如 C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,
    同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以
    及 if、 for、 do、 while、 switch、 case 语句中的程序都要采用如上的缩进方式。
    示例:如下例子不符合规范。
    for (...) {
    ... // program code
    }
    if (...)
    {
    ... // program code
    }
    void example_fun( void )
    {
    ... // program code
    }
    应如下书写。
    for (...)
    {
    ... // program code
    }
    if (...)
    {
    ... // program code
    }
    void example_fun( void )
    {
    ... // program code
    }
    1-7:一行程序以小于 80 字符为宜,不要写得过长。

2 注释

2-1:一般情况下,源程序有效注释量必须在 20%以上。
说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能
太少,注释语言必须准确、易懂、简洁。
2-2:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再
有用的注释要删除。
2-3:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)
相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。
示例:如下例子不符合规范。
例 1:
/* get replicate sub system index and net indicator */

repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
例 2:
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
/* get replicate sub system index and net indicator /
应如下书写
/
get replicate sub system index and net indicator /
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
2-4:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须
加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
示例:
/
active statistic task number */

define MAX_ACT_TASK_NUMBER 1000

define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number /
2-5:注释与所描述内容进行同样的缩排。
说明:可使程序排版整齐,并方便注释的阅读与理解。
示例:如下例子,排版不整齐,阅读稍感不方便。
void example_fun( void )
{
/
code one comments /
CodeBlock One
/
code two comments /
CodeBlock Two
}
应改为如下布局。
void example_fun( void )
{
/
code one comments /
CodeBlock One
/
code two comments /
CodeBlock Two
}
2-6:在程序块的结束行右方加注释标记,以表明某程序块的结束。
说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。
示例:参见如下例子。
if (...)
{
// program code
while (index < MAX_INDEX)
{
// program code
} /
end of while (index < MAX_INDEX) / // 指明该条 while 语句结束
} /
end of if (...)/ // 指明是哪条 if 语句结束
2-7:注释格式尽量统一,建议使用“/
…… */”。
2-8:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用
中文,除非能用非常流利准确的英文表达。
说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中
文。

3 标识符命名

3-1:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解
的缩写,避免使人产生误解。
说明:较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成缩
写;一些单词有大家公认的缩写。
示例:如下单词的缩写能够被大家基本认可。
temp 可缩写为 tmp ;
flag 可缩写为 flg ;
statistic 可缩写为 stat ;
increment 可缩写为 inc ;
message 可缩写为 msg ;
3-2:命名中若使用特殊约定或缩写,则要有注释说明。
说明:应该在源文件的开始之处,对文件中所使用的缩写或约定,特别是特殊的缩写,进行
必要的注释说明。
3-3:自己特有的命名风格,要自始至终保持一致,不可来回变化。
说明:个人的命名风格,在符合所在项目组或产品组的命名规则的前提下,才可使用。(即
命名规则中没有规定到的地方才可有个人命名风格)。
3-4:对于变量命名,禁止取单个字符(如 i、 j、 k...),建议除了要有具体含义外,还能表
明其变量类型、数据类型等,但 i、 j、 k 作局部循环变量是允许的。
说明:变量,尤其是局部变量,如果用单个字符表示,很容易敲错(如 i 写成 j),而编译时
又检查不出来,有可能为了这个小小的错误而花费大量的查错时间。
示例:下面所示的局部变量名的定义方法可以借鉴。
int liv_Width
其变量名解释如下:
l 局部变量(Local) (其它: g 全局变量(Global) ...)
i 数据类型(Interger)
v 变量(Variable) (其它: c 常量(Const) ...)
Width 变量含义
这样可以防止局部变量与全局变量重名。
3-5:命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,比如采用 UNIX
的全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方式,用
作特殊标识如标识成员变量或全局变量的 m_和 g_,其后加上大小写混排的方式是允许的。
示例: Add_User 不允许, add_user、 AddUser、 m_AddUser 允许。
3-6:在同一软件产品内,应规划好接口部分标识符(变量、结构、函数及常量)的命名,
防止编译、链接时产生冲突。
说明:对接口部分的标识符应该有更严格限制,防止冲突。如可规定接口部分的变量与常量
之前加上“模块”标识等。
3-7:用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
说明:下面是一些在软件中常用的反义词组。
add / remove begin / end create / destroy
insert / delete first / last get / release
increment / decrement put / get
add / delete lock / unlock open / close
min / max old / new start / stop
next / previous source / target show / hide
send / receive source / destination
cut / paste up / down
示例:
int min_sum;
int max_sum;
int add_user( BYTE user_name );
int delete_user( BYTE
user_name );

4 可读性

4-1:注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。
4-2:函数的规模尽量限制在 200 行以内。

最新文章

123

最新摄影

微信扫一扫

第七城市微信公众平台