C语言编程规范——排版

2019-06-15  本文已影响0人  一丠

前言

制定C语言的编程规范,对代码的清晰、简洁、可测试、安全、程序效率、可移植各个方面有巨大的作用。

良好的注释能让整个代码读起来更加流畅,此乃程序猿出差旅行,通宵熬夜必备良药......

1-1:程序块要采用缩进风格编写,缩进的空格数为4个。

说明:对于由开发工具自动生成的代码可以有不一致。

1-2:相对独立的程序块之间、变量说明之后必须加空行。

示例:如下例子不符合规范。

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-3:较长的语句(>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-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。

示例:

if ((taskno < max_act_task_number)

  && (n7stat_stat_item_valid (stat_item)))

{

  ... // program code

}

for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length)

                  && (j < NewKeyword.word_length); i++, j++)

{

  ... // program code

}

for (i = 0, j = 0; 

    (i < first_word_length) && (j < second_word_length); 

    i++, j++)

{

  ... // program code

}

1-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 );

1-6:不允许把多个短语句写在一行中,即一行只写一条语句。

示例:如下例子不符合规范。

rect.length = 0;  rect.width = 0;

应如下书写

rect.length = 0;

rect.width  = 0;

1-7:if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

示例:如下例子不符合规范。

if (pUserCR == NULL) return;

应如下书写:

if (pUserCR == NULL)

{

  return;

}

1-8:对齐只使用空格键,不使用TAB键。

说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐,不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键,因此使用BC合入的版本大多会将缩进变乱。

1-9:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。

1-10:程序块的分界符(如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

}

愿你出走半生,归来仍是少年…

上一篇下一篇

猜你喜欢

热点阅读