软件编码规范和范例.docVIP

软件编码标准和范例

目录

TOC\o1-3\h\z\u软件编码标准和范例 1

1. 排版 2

2. 注释 6

3. 命名标准 11

4. 可读性 17

5. 变量、结构 19

6. 函数、过程 20

7. 可测性 22

8. 程序效率 25

9. 质量保证 27

10. 代码编辑、编译、审查 33

11. 代码测试、维护 34

12. 宏〔适用于C/C++〕 35

修改建议：

注释应该标准一下格式,比方文件注释用块语句注释用//之类,重要的是要留下编码人员的姓名和时间,便于问题跟踪

针对异常处理的标准

程序效率的问题很难,不是简单的代码走查就能检测的了的，这个不好度量

建议增加文档夹、娄、接口、方法的命名规那么

排版

较长的语句〔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=((tasknoMAX_ACT_TASK_NUMBER)

(n7stat_stat_item_valid(stat_item))

(act_task_table[taskno].result_data!=0));

循环、判断等语句中假设有较长的表达式或语句，那么要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。

例如：

if((tasknomax_act_task_number)

(n7stat_stat_item_valid(stat_item)))

{

...//programcode

}

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

(jNewKeyword.word_length);i++,j++)

{

...//programcode

}

for(i=0,j=0;

(ifirst_word_length)(jsecond_word_length);

i++,j++)

{

...//programcode

}

假设函数或过程中的参数较长，那么要进行适当的划分。

例如：

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

不允许把多个短语句写在一行中，即一行只写一条语句。

例如：如下例子不符合标准。

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

应如下书写

rect.length=0;

rect.width=0;

程序块的分界符〔如C/C++语言的大括号‘{’和‘}’〕应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

例如：如下例子不符合标准。

for(...){

...//programcod