软件编程规范之排版

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

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

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

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

<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

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

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

示例:
如下例子不符合规范。
rect.length = 0; rect.width = 0;
应如下书写 。
rect.length = 0;
rect.width = 0;

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

示例:
如下例子不符合规范。
if (pUserCR == NULL) return;
应如下书写:
if (pUserCR == NULL)
{
       return;
}

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

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

<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
}

<11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。

说明:
采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C++语言中括号已经是最清晰的标志了。
在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。

示例:
(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);

<12:一行程序以小于80字符为宜,不要写得过长。

您可能还喜欢...

13 条回复

  1. JiaCheng说道:

    看不懂!看不懂!

  2. 健康播报说道:

    我一般很少动代码,呵呵。
    .-= 健康播报发表了新的文章 ..健康孕妇,健康饮食! =-.

  3. whitmine说道:

    等着哈,我去找个明白人来看看~!~ 😯
    .-= whitmine发表了新的文章 ..晒宝 =-.

  4. A.shun说道:

    最怕这种条条框框的
    .-= A.shun发表了新的文章 ..接踵而来的悲剧 =-.

  5. 阿东说道:

    编程不会哦。。看不懂。 。
    不过我想整个编辑下来能一目了解就是好的排版。。呵呵。。
    .-= 阿东发表了新的文章 ..[建国大业]南京首映礼[TV-RMVB/515MB][高清无水印] =-.

  6. kangzj说道:

    不错,学习了,经常写程序,有些习惯改不了了,呵呵
    .-= kangzj发表了新的文章 ..基于Google自定义搜索的“Google师大” =-.

回复 whitmine 取消回复

您的电子邮箱地址不会被公开。 必填项已用*标注

此站点使用Akismet来减少垃圾评论。了解我们如何处理您的评论数据