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

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

            <td height="20">
              <p align="center"><font color="#FFFFFF">==关于文章版权==</font></td>
          </tr>
		  <tr>
            <td height="20"><font color="#FFFFFF"><br>
              “本站”本站站主原创文章，未经本人（帝国老手/aoe）许可其他媒体一律不得转载。<br><br>
              “本站整理”本站站主根据个人见解及他人经验总结整理的文章，其他媒体转载必须标明出处为我站。<br><br>
              “某单位或个人”全文转载来自网络上的文章，其他媒体转载与我站无关。<br><br>
              “未知”（1）来自网络，由于来源混乱，无从考证作者，其他媒体转载与我站无关。<br><br>
              “未知”（2）其文章也是本站站主原创的，只所以标注“未知”，主要是因为引用文字过多或其他原因。建议其他媒体转载标明出处为我站。<br><br>
              我站版权请标注：“www.cetinet.com”或“中国电子技术信息网”字样。</font></td>
          </tr>
          <tr>
            <td height="20"></td>
          </tr>
		</table>
      </td>
      <td width="600" valign="top" height="240">
        <table width="600" border="0" cellspacing="0" cellpadding="0" height="20">
          <tr>
            <td bgcolor="#5B9595">&nbsp;</td>
          </tr>
        </table>
        <table width="600" border="0" cellspacing="3" cellpadding="0">
          <tr>
            <td height="20" bgcolor="#AECECE">
              <div align="center">
                <font color="#0A52D8"><b>编程规范与范例(3)</b></font>
              </div>
            </td>
          </tr>
          <tr>
            <td width="600">〖文章转载或出处〗≡中国电子技术信息网≡ 网址：www.CETINet.com</td>  
          </tr>
          <tr>
            <td width="600">编程规范与范例(3)<br>
<br>
目&nbsp;&nbsp;录<br>
1&nbsp;排版&nbsp;6<br>
2&nbsp;注释&nbsp;11<br>
3&nbsp;标识符命名&nbsp;18<br>
4&nbsp;可读性&nbsp;20<br>
5&nbsp;变量、结构&nbsp;22<br>
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>
<br>
<br>
6&nbsp;函数、过程<br>
&amp;sup1;&nbsp;6-1：对所调用函数的错误返回码要仔细、全面地处理。<br>
&amp;sup1;&nbsp;6-2：明确函数功能，精确（而不是近似）地实现函数设计。<br>
&amp;sup1;&nbsp;6-3：编写可重入函数时，应注意局部变量的使用（如编写C/C++语言的可重入函数时，应使用auto即缺省态局部变量或寄存器变量）。<br>
说明：编写C/C++语言的可重入函数时，不应使用static局部变量，否则必须经过特殊处理，才能使函数具有可重入性。<br>
&amp;sup1;&nbsp;6-4：编写可重入函数时，若使用全局变量，则应通过关中断、信号量（即P、V操作）等手段对其加以保护。<br>
说明：若对所使用的全局变量不加以保护，则此函数就不具有可重入性，即当多个进程调用此函数时，很有可能使有关全局变量变为不可知状态。<br>
示例：假设Exam是int型全局变量，函数Squre_Exam返回Exam平方值。那么如下函数不具有可重入性。<br>
unsigned&nbsp;int&nbsp;example(&nbsp;int&nbsp;para&nbsp;)<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;temp;<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;Exam&nbsp;=&nbsp;para;&nbsp;//&nbsp;（**）<br>
&nbsp;&nbsp;&nbsp;&nbsp;temp&nbsp;=&nbsp;Square_Exam(&nbsp;);<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;temp;<br>
}<br>
<br>
此函数若被多个进程调用的话，其结果可能是未知的，因为当（**）语句刚执行完后，另外一个使用本函数的进程可能正好被激活，那么当新激活的进程执行到此函数时，将使Exam赋与另一个不同的para值，所以当控制重新回到“temp&nbsp;=&nbsp;Square_Exam(&nbsp;)”后，计算出的temp很可能不是预想中的结果。此函数应如下改进。<br>
unsigned&nbsp;int&nbsp;example(&nbsp;int&nbsp;para&nbsp;)<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;temp;<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;[申请信号量操作]&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;若申请不到“信号量”，说明另外的进程正处于<br>
&nbsp;&nbsp;&nbsp;&nbsp;Exam&nbsp;=&nbsp;para;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;给Exam赋值并计算其平方过程中（即正在使用此<br>
&nbsp;&nbsp;&nbsp;&nbsp;temp&nbsp;=&nbsp;Square_Exam(&nbsp;);&nbsp;&nbsp;//&nbsp;信号），本进程必须等待其释放信号后，才可继<br>
&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;&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;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;用本信号。<br>
&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;temp;<br>
}<br>
&amp;sup1;&nbsp;6-5：在同一项目组应明确规定对接口函数参数的合法性检查应由函数的调用者负责还是由接口函数本身负责，缺省是由函数调用者负责。<br>
说明：对于模块间接口函数的参数的合法性检查这一问题，往往有两个极端现象，即：要么是调用者和被调用者对参数均不作合法性检查，结果就遗漏了合法性检查这一必要的处理过程，造成问题隐患；要么就是调用者和被调用者均对参数进行合法性检查，这种情况虽不会造成问题，但产生了冗余代码，降低了效率。<br>
&amp;frac12;&nbsp;6-1：防止将函数的参数作为工作变量。<br>
说明：将函数的参数作为工作变量，有可能错误地改变参数内容，所以很危险。对必须改变的参数，最好先用局部变量代之，最后再将该局部变量的内容赋给该参数。<br>
示例：下函数的实现不太好。<br>
void&nbsp;sum_data(&nbsp;unsigned&nbsp;int&nbsp;num,&nbsp;int&nbsp;*data,&nbsp;int&nbsp;*sum&nbsp;)<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;count;<br>
&nbsp;&nbsp;&nbsp;&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;*sum&nbsp;=&nbsp;0;<br>
&nbsp;&nbsp;&nbsp;&nbsp;for&nbsp;(count&nbsp;=&nbsp;0;&nbsp;count&nbsp;&lt;&nbsp;num;&nbsp;count++)<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*sum&nbsp;&nbsp;+=&nbsp;data[count];&nbsp;//&nbsp;sum成了工作变量，不太好。<br>
&nbsp;&nbsp;&nbsp;&nbsp;}<br>
}<br>
<br>
若改为如下，则更好些。<br>
void&nbsp;sum_data(&nbsp;unsigned&nbsp;int&nbsp;num,&nbsp;int&nbsp;*data,&nbsp;int&nbsp;*sum&nbsp;)<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;count&nbsp;;<br>
&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;sum_temp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;sum_temp&nbsp;=&nbsp;0;<br>
&nbsp;&nbsp;&nbsp;&nbsp;for&nbsp;(count&nbsp;=&nbsp;0;&nbsp;count&nbsp;&lt;&nbsp;num;&nbsp;count&nbsp;++)<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sum_temp&nbsp;&nbsp;+=&nbsp;data[count];&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;}<br>
&nbsp;&nbsp;&nbsp;&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;*sum&nbsp;=&nbsp;sum_temp;<br>
}<br>
&amp;frac12;&nbsp;6-2：函数的规模尽量限制在200行以内。<br>
说明：不包括注释和空格行。<br>
&amp;frac12;&nbsp;6-3：一个函数仅完成一件功能。<br>
&amp;frac12;&nbsp;6-4：为简单功能编写函数。<br>
说明：虽然为仅用一两行就可完成的功能去编函数好象没有必要，但用函数可使功能明确化，增加程序可读性，亦可方便维护、测试。<br>
示例：如下语句的功能不很明显。<br>
value&nbsp;=&nbsp;(&nbsp;a&nbsp;&gt;&nbsp;b&nbsp;)&nbsp;?&nbsp;a&nbsp;:&nbsp;b&nbsp;;<br>
<br>
改为如下就很清晰了。<br>
int&nbsp;max&nbsp;(int&nbsp;a,&nbsp;int&nbsp;b)<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;((a&nbsp;&gt;&nbsp;b)&nbsp;?&nbsp;a&nbsp;:&nbsp;b);<br>
}<br>
<br>
value&nbsp;=&nbsp;max&nbsp;(a,&nbsp;b);<br>
<br>
或改为如下。<br>
#define&nbsp;MAX&nbsp;(a,&nbsp;b)&nbsp;(((a)&nbsp;&gt;&nbsp;(b))&nbsp;?&nbsp;(a)&nbsp;:&nbsp;(b))<br>
<br>
value&nbsp;=&nbsp;MAX&nbsp;(a,&nbsp;b);<br>
&amp;frac12;&nbsp;6-5：不要设计多用途面面俱到的函数。<br>
说明：多功能集于一身的函数，很可能使函数的理解、测试、维护等变得困难。<br>
&amp;frac12;&nbsp;6-6：函数的功能应该是可以预测的，也就是只要输入数据相同就应产生同样的输出。<br>
说明：带有内部“存储器”的函数的功能可能是不可预测的，因为它的输出可能取决于内部存储器（如某标记）的状态。这样的函数既不易于理解又不利于测试和维护。在C/C++语言中，函数的static局部变量是函数的内部存储器，有可能使函数的功能不可预测，然而，当某函数的返回值为指针类型时，则必须是STATIC的局部变量的地址作为返回值，若为AUTO类，则返回为错针。<br>
示例：如下函数，其返回值（即功能）是不可预测的。<br>
unsigned&nbsp;int&nbsp;integer_sum(&nbsp;unsigned&nbsp;int&nbsp;base&nbsp;)<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;index;<br>
&nbsp;&nbsp;&nbsp;&nbsp;static&nbsp;unsigned&nbsp;int&nbsp;sum&nbsp;=&nbsp;0;&nbsp;//&nbsp;注意，是static类型的。<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;若改为auto类型，则函数即变为可预测。<br>
&nbsp;&nbsp;&nbsp;&nbsp;for&nbsp;(index&nbsp;=&nbsp;1;&nbsp;index&nbsp;&lt;=&nbsp;base;&nbsp;index++)<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sum&nbsp;+=&nbsp;index;<br>
&nbsp;&nbsp;&nbsp;&nbsp;}<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;sum;<br>
}<br>
&amp;frac12;&nbsp;6-7：尽量不要编写依赖于其他函数内部实现的函数。<br>
说明：此条为函数独立性的基本要求。由于目前大部分高级语言都是结构化的，所以通过具体语言的语法要求与编译器功能，基本就可以防止这种情况发生。但在汇编语言中，由于其灵活性，很可能使函数出现这种情况。<br>