编程规范与范例(1).htm

编程规范与范例。从网上收集的

6&nbsp;函数、过程&nbsp;28<br>
7&nbsp;可测性&nbsp;36<br>
8&nbsp;程序效率&nbsp;40<br>
9&nbsp;质量保证&nbsp;44<br>
10&nbsp;代码编辑、编译、审查&nbsp;50<br>
11&nbsp;代码测试、维护&nbsp;52<br>
12&nbsp;宏&nbsp;53<br>
&nbsp;<br>
1&nbsp;排版<br>
&amp;sup1;&nbsp;1-1：程序块要采用缩进风格编写，缩进的空格数为4个。<br>
说明：对于由开发工具自动生成的代码可以有不一致。<br>
&amp;sup1;&nbsp;1-2：相对独立的程序块之间、变量说明之后必须加空行。<br>
示例：如下例子不符合规范。<br>
if&nbsp;(!valid_ni(ni))<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;//&nbsp;program&nbsp;code<br>
}<br>
repssn_ind&nbsp;=&nbsp;ssn_data[index].repssn_index;<br>
repssn_ni&nbsp;&nbsp;=&nbsp;ssn_data[index].ni;<br>
<br>
应如下书写<br>
if&nbsp;(!valid_ni(ni))<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;//&nbsp;program&nbsp;code<br>
}<br>
<br>
repssn_ind&nbsp;=&nbsp;ssn_data[index].repssn_index;<br>
repssn_ni&nbsp;&nbsp;=&nbsp;ssn_data[index].ni;<br>
&amp;sup1;&nbsp;1-3：较长的语句（&gt;80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。<br>
示例：<br>
perm_count_msg.head.len&nbsp;=&nbsp;NO7_TO_STAT_PERM_COUNT_LEN<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+&nbsp;STAT_SIZE_PER_FRAM&nbsp;*&nbsp;sizeof(&nbsp;_UL&nbsp;);<br>
<br>
act_task_table[frame_id&nbsp;*&nbsp;STAT_TASK_CHECK_NUMBER&nbsp;+&nbsp;index].occupied<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;=&nbsp;stat_poi[index].occupied;<br>
<br>
act_task_table[taskno].duration_true_or_false<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;=&nbsp;SYS_get_sccp_statistic_state(&nbsp;stat_item&nbsp;);<br>
<br>
report_or_not_flag&nbsp;=&nbsp;((taskno&nbsp;&lt;&nbsp;MAX_ACT_TASK_NUMBER)<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;&amp;&nbsp;(n7stat_stat_item_valid&nbsp;(stat_item))<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;&amp;&nbsp;(act_task_table[taskno].result_data&nbsp;!=&nbsp;0));<br>
&nbsp;<br>
&amp;sup1;&nbsp;1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。<br>
示例：<br>
if&nbsp;((taskno&nbsp;&lt;&nbsp;max_act_task_number)<br>
&nbsp;&nbsp;&nbsp;&nbsp;&amp;&amp;&nbsp;(n7stat_stat_item_valid&nbsp;(stat_item)))<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;//&nbsp;program&nbsp;code<br>
}<br>
<br>
for&nbsp;(i&nbsp;=&nbsp;0,&nbsp;j&nbsp;=&nbsp;0;&nbsp;(i&nbsp;&lt;&nbsp;BufferKeyword[word_index].word_length)<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;&amp;&nbsp;(j&nbsp;&lt;&nbsp;NewKeyword.word_length);&nbsp;i++,&nbsp;j++)<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;//&nbsp;program&nbsp;code<br>
}<br>
<br>
for&nbsp;(i&nbsp;=&nbsp;0,&nbsp;j&nbsp;=&nbsp;0;&nbsp;&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(i&nbsp;&lt;&nbsp;first_word_length)&nbsp;&amp;&amp;&nbsp;(j&nbsp;&lt;&nbsp;second_word_length);&nbsp;&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;i++,&nbsp;j++)<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;//&nbsp;program&nbsp;code&nbsp;<br>
}<br>
&amp;sup1;&nbsp;1-5：若函数或过程中的参数较长，则要进行适当的划分。<br>
示例：<br>
n7stat_str_compare((BYTE&nbsp;*)&nbsp;&amp;&nbsp;stat_object,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(BYTE&nbsp;*)&nbsp;&amp;&nbsp;(act_task_table[taskno].stat_object),<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sizeof&nbsp;(_STAT_OBJECT));<br>
<br>
n7stat_flash_act_duration(&nbsp;stat_item,&nbsp;frame_id&nbsp;*STAT_TASK_CHECK_NUMBER<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+&nbsp;index,&nbsp;stat_object&nbsp;);<br>
&amp;sup1;&nbsp;1-6：不允许把多个短语句写在一行中，即一行只写一条语句。<br>
示例：如下例子不符合规范。<br>
rect.length&nbsp;=&nbsp;0;&nbsp;&nbsp;rect.width&nbsp;=&nbsp;0;<br>
<br>
应如下书写<br>
rect.length&nbsp;=&nbsp;0;<br>
rect.width&nbsp;&nbsp;=&nbsp;0;<br>
&amp;sup1;&nbsp;1-7：if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。&nbsp;<br>
示例：如下例子不符合规范。<br>
if&nbsp;(pUserCR&nbsp;==&nbsp;NULL)&nbsp;return;<br>
<br>
应如下书写：<br>
if&nbsp;(pUserCR&nbsp;==&nbsp;NULL)<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;return;<br>
}<br>
&amp;sup1;&nbsp;1-8：对齐只使用空格键，不使用TAB键。<br>
说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐，不要使用BC作为编辑器合版本，因为BC会自动将8个空格变为一个TAB键，因此使用BC合入的版本大多会将缩进变乱。<br>
&amp;sup1;&nbsp;1-9：函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。<br>
&amp;sup1;&nbsp;1-10：程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。<br>
示例：如下例子不符合规范。<br>
for&nbsp;(...)&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;//&nbsp;program&nbsp;code<br>
}<br>
<br>
if&nbsp;(...)&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;//&nbsp;program&nbsp;code<br>
&nbsp;&nbsp;&nbsp;&nbsp;}<br>
<br>
void&nbsp;example_fun(&nbsp;void&nbsp;)<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;//&nbsp;program&nbsp;code<br>
&nbsp;&nbsp;&nbsp;&nbsp;}<br>
<br>
应如下书写。<br>
for&nbsp;(...)&nbsp;<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;//&nbsp;program&nbsp;code<br>
}<br>
<br>
if&nbsp;(...)&nbsp;<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;//&nbsp;program&nbsp;code<br>
}<br>
<br>
void&nbsp;example_fun(&nbsp;void&nbsp;)<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;//&nbsp;program&nbsp;code<br>
}<br>
&amp;sup1;&nbsp;1-11：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－&gt;），后不应加空格。<br>
说明：采用这种松散方式编写代码的目的是使代码更加清晰。<br>
由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在C/C++语言中括号已经是最清晰的标志了。<br>
在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。<br>
<br>
示例：<br>
(1)&nbsp;逗号、分号只在后面加空格。<br>
int&nbsp;a,&nbsp;b,&nbsp;c;&nbsp;<br>
<br>
(2)比较操作符,&nbsp;赋值操作符&quot;=&quot;、&nbsp;&quot;+=&quot;，算术操作符&quot;+&quot;、&quot;%&quot;，逻辑操作符&quot;&amp;&amp;&quot;、&quot;&amp;&quot;，位域操作符&quot;&lt;&lt;&quot;、&quot;^&quot;等双目操作符的前后加空格。<br>
if&nbsp;(current_time&nbsp;&gt;=&nbsp;MAX_TIME_VALUE)&nbsp;<br>
a&nbsp;=&nbsp;b&nbsp;+&nbsp;c;<br>
a&nbsp;*=&nbsp;2;<br>
a&nbsp;=&nbsp;b&nbsp;^&nbsp;2;<br>
<br>
(3)&quot;!&quot;、&quot;~&quot;、&quot;++&quot;、&quot;--&quot;、&quot;&amp;&quot;（地址运算符）等单目操作符前后不加空格。<br>
*p&nbsp;=&nbsp;'a';&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;内容操作&quot;*&quot;与内容之间<br>
flag&nbsp;=&nbsp;!isEmpty;&nbsp;//&nbsp;非操作&quot;!&quot;与内容之间<br>
p&nbsp;=&nbsp;&amp;mem;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;地址操作&quot;&amp;&quot;&nbsp;与内容之间<br>
i++;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;&quot;++&quot;,&quot;--&quot;与内容之间<br>
<br>
(4)&quot;-&gt;&quot;、&quot;.&quot;前后不加空格。<br>
p-&gt;id&nbsp;=&nbsp;pid;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;&quot;-&gt;&quot;指针前后不加空格<br>
<br>
(5)&nbsp;if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。<br>
if&nbsp;(a&nbsp;&gt;=&nbsp;b&nbsp;&amp;&amp;&nbsp;c&nbsp;&gt;&nbsp;d)<br>
&amp;frac12;&nbsp;1-1：一行程序以小于80字符为宜，不要写得过长。<br>
&nbsp;<br>
2&nbsp;注释<br>
&amp;sup1;&nbsp;2-1：一般情况下，源程序有效注释量必须在20％以上。<br>
说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。<br>
&amp;sup1;&nbsp;2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。<br>
示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。<br>
/*************************************************<br>
&nbsp;&nbsp;Copyright&nbsp;(C),&nbsp;1988-1999,&nbsp;Huawei&nbsp;Tech.&nbsp;Co.,&nbsp;Ltd.<br>
&nbsp;&nbsp;File&nbsp;name:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;文件名<br>
&nbsp;&nbsp;Author:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Version:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Date:&nbsp;//&nbsp;作者、版本及完成日期<br>
&nbsp;&nbsp;Description:&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;用于详细说明此程序文件完成的主要功能，与其他模块<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;或函数的接口，输出值、取值范围、含义及参数间的控<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;制、顺序、独立或依赖等关系<br>
&nbsp;&nbsp;Others:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;其它内容的说明<br>
&nbsp;&nbsp;Function&nbsp;List:&nbsp;&nbsp;//&nbsp;主要函数列表，每条记录应包括函数名及功能简要说明<br>
&nbsp;&nbsp;&nbsp;&nbsp;1.&nbsp;....<br>
&nbsp;&nbsp;History:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;修改历史记录列表，每条修改记录应包括修改日期、修改<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;者及修改内容简述&nbsp;&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;1.&nbsp;Date:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Author:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Modification:<br>
&nbsp;&nbsp;&nbsp;&nbsp;2.&nbsp;...<br>
*************************************************/<br>
&amp;sup1;&nbsp;2-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。<br>
示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。<br>
/************************************************************<br>
&nbsp;&nbsp;Copyright&nbsp;(C),&nbsp;1988-1999,&nbsp;Huawei&nbsp;Tech.&nbsp;Co.,&nbsp;Ltd.<br>
&nbsp;&nbsp;FileName:&nbsp;test.cpp<br>
&nbsp;&nbsp;Author:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Version&nbsp;:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Date:<br>
&nbsp;&nbsp;Description:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;模块描述&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>
&nbsp;&nbsp;Version:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;版本信息<br>
&nbsp;&nbsp;Function&nbsp;List:&nbsp;&nbsp;&nbsp;//&nbsp;主要函数及其功能<br>
&nbsp;&nbsp;&nbsp;&nbsp;1.&nbsp;-------<br>
&nbsp;&nbsp;History:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;历史修改记录<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;author&gt;&nbsp;&nbsp;&lt;time&gt;&nbsp;&nbsp;&nbsp;&lt;version&nbsp;&gt;&nbsp;&nbsp;&nbsp;&lt;desc&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;David&nbsp;&nbsp;&nbsp;&nbsp;96/10/12&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;build&nbsp;this&nbsp;moudle&nbsp;&nbsp;<br>
***********************************************************/<br>
说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。<br>
&amp;sup1;&nbsp;2-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。<br>
示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。<br>
/*************************************************<br>
&nbsp;&nbsp;Function:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;函数名称<br>
&nbsp;&nbsp;Description:&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;函数功能、性能等的描述<br>
&nbsp;&nbsp;Calls:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;被本函数调用的函数清单<br>
&nbsp;&nbsp;Called&nbsp;By:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;调用本函数的函数清单<br>
&nbsp;&nbsp;Table&nbsp;Accessed:&nbsp;//&nbsp;被访问的表（此项仅对于牵扯到数据库操作的程序）<br>
&nbsp;&nbsp;Table&nbsp;Updated:&nbsp;&nbsp;//&nbsp;被修改的表（此项仅对于牵扯到数据库操作的程序）<br>