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

编程规范大全

<P>&nbsp;&nbsp;&nbsp; /* code two comments */<BR>&nbsp;&nbsp;&nbsp; CodeBlock Two<BR>}<BR>&amp;sup1; 2-13：将注释与其上面的代码用空行隔开。<BR>示例：如下例子，显得代码过于紧凑。<BR>/* code one comments */<BR>program code one<BR>/* code two comments */<BR>program code two</P>
<P>应如下书写<BR>/* code one comments */<BR>program code one</P>
<P>/* code two comments */<BR>program code two<BR>&amp;sup1; 2-14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。<BR>说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。<BR>&amp;sup1; 2-15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。<BR>说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。<BR>示例（注意斜体加粗部分）：<BR>case CMD_UP:&nbsp;&nbsp; <BR>&nbsp;&nbsp;&nbsp; ProcessUp(); <BR>&nbsp;&nbsp;&nbsp; break;</P>
<P>case CMD_DOWN: <BR>&nbsp;&nbsp;&nbsp; ProcessDown(); <BR>&nbsp;&nbsp;&nbsp; break;</P>
<P>case CMD_FWD:&nbsp; <BR>&nbsp;&nbsp;&nbsp; ProcessFwd(); <BR>&nbsp;&nbsp;&nbsp; <BR>if (...)<BR>{<BR>&nbsp;&nbsp;&nbsp; ...<BR>&nbsp;&nbsp;&nbsp; break;<BR>}<BR>else<BR>{<BR>&nbsp;&nbsp;&nbsp; ProcessCFW_B();&nbsp;&nbsp; // now jump into case CMD_A<BR>}</P>
<P>case CMD_A:&nbsp;&nbsp;&nbsp; <BR>&nbsp;&nbsp;&nbsp; ProcessA();&nbsp;&nbsp;&nbsp; <BR>&nbsp;&nbsp;&nbsp; break;</P>
<P>case CMD_B:&nbsp;&nbsp;&nbsp; <BR>&nbsp;&nbsp;&nbsp; ProcessB();&nbsp;&nbsp;&nbsp; <BR>&nbsp;&nbsp;&nbsp; break;</P>
<P>case CMD_C:&nbsp;&nbsp;&nbsp; <BR>&nbsp;&nbsp;&nbsp; ProcessC();&nbsp;&nbsp;&nbsp; <BR>&nbsp; break;</P>
<P>case CMD_D:&nbsp;&nbsp;&nbsp; <BR>&nbsp;&nbsp;&nbsp; ProcessD();&nbsp;&nbsp;&nbsp; <BR>&nbsp;&nbsp;&nbsp; break;<BR>...<BR>&amp;frac12; 2-1：避免在一行代码或表达式的中间插入注释。<BR>说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。<BR>&amp;frac12; 2-2：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。<BR>说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。<BR>&amp;frac12; 2-3：在代码的功能、意图层次上进行注释，提供有用、额外的信息。<BR>说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。<BR>示例：如下注释意义不大。<BR>/* if receive_flag is TRUE */<BR>if (receive_flag)</P>
<P>而如下的注释则给出了额外有用的信息。 <BR>/* if mtp receive a message from links */<BR>if (receive_flag)<BR>&amp;frac12; 2-4：在程序块的结束行右方加注释标记，以表明某程序块的结束。<BR>说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。<BR>示例：参见如下例子。<BR>if (...)<BR>{<BR>&nbsp;&nbsp;&nbsp; // program code</P>
<P>&nbsp;&nbsp;&nbsp; while (index &lt; MAX_INDEX)<BR>&nbsp;&nbsp;&nbsp; {<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // program code<BR>&nbsp;&nbsp;&nbsp; } /* end of while (index &lt; MAX_INDEX) */ // 指明该条while语句结束<BR>} /* end of&nbsp; if (...)*/ // 指明是哪条if语句结束<BR>&amp;frac12; 2-5：注释格式尽量统一，建议使用“/* …… */”。<BR>&amp;frac12; 2-6：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。<BR>说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。<BR>&nbsp;<A></A></P></DIV></TD></TR></TBODY></TABLE><FONT color=#ff0000></FONT>
<P align=right><A href="http://blog.21ic.org/blog.asp?name=cxjr" target=_blank><FONT color=#ff0000>如果你的‘芯’是一座作坊，我愿做那不知疲倦的程序匠。打造一流博客，我们每天在努力！</FONT></A></P><A href="http://blog.21ic.org/blog.asp?name=cxjr" target=_blank><FONT color=#ff0000></FONT></A><br><a name='comment'></a><table width='90%' border='0' align='center' cellspacing='0' cellpadding='0'> <tr> <td><strong>发表评论：</strong></tr></td></table>
<table width='90%' border='0' align='center' cellspacing='0' cellpadding='0'> <tr> <td><table align='left' width='100%' border='0' cellspacing='0' cellpadding='0'>
<form action='more.asp?name=cxjr&id=2754&action=addcomment_ic' method='post' name='commentform' onSubmit='return Verifycomment()'>
<tr><td height='25'  align='left'>昵称：<input name='UserName' type='text' id='UserName' size='15' maxlength='20' value=''></td></tr>
<tr><td height='25' align='left'>密码：<input name='Password' type='password' id='Password' size='15' maxlength='20' value=''> (游客无须输入密码)</td></tr>
<tr ><td height='25' align='left'  >验证码：<input name='GetCode' type='text' id='GetCode' size='12' maxlength='20' />&nbsp;<img src='inc/code.asp' width='40' height='10' border='0' /><td></tr><tr ><td height='25' align='left'  >主页：<input name='homepage' type='text' id='homepage' size='42' maxlength='50' value='http://'><td></tr><tr ><td height='25' align='left'  >标题：<input name='commenttopic' type='text' id='commenttopic' size='42' maxlength='50' value='回复:编程规范与范例(1)'><td></tr><tr height='200'><td ><INPUT type='hidden' name='edit' id='edit' value=''>
<link rel="STYLESHEET" type="text/css" href="images/edit.css">
<Script Src="images/DhtmlEdit.js"></Script>
<table id="oblog_Container" class="oblog_Body" height=100% width=350 cellpadding=1 cellspacing=0 border=0 >
  <tr> 
    <td  height="10"> <table cellpadding=0 cellspacing=0 >
        <tr class="yToolbar" ID="ExtToolbar0" > 
          <td> <select language="javascript" class="oblog_TBGen" id="FontSize" onchange="FormatText('fontsize',this[this.selectedIndex].value);">
              <option class="heading" selected>字号 
              <option value="1">1 
              <option value="2">2 
              <option value="3">3 
              <option value="4">4 
              <option value="5">5 
              <option value="6">6 
              <option value="7">7</option>
            </select> 
          <td class="oblog_Btn" TITLE="加粗" LANGUAGE="javascript" onclick="FormatText('bold', '');ondrag='return false;'" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn'; > 
            <img class="oblog_Ico" src="images/bold.gif" WIDTH="16" HEIGHT="16" unselectable="on"> </td>
          <td class="oblog_Btn" TITLE="斜体" LANGUAGE="javascript" onclick="FormatText('italic', '');ondrag='return false;'" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn'; > 
            <img class="oblog_Ico" src="images/italic.gif" WIDTH="16" HEIGHT="16" unselectable="on"> </td>
          <td class="oblog_Btn" TITLE="下划线" LANGUAGE="javascript" onclick="FormatText('underline', '');ondrag='return false;'" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn'; > 
            <img class="oblog_Ico" src="images/underline.gif" WIDTH="16" HEIGHT="16" unselectable="on"> </td>
          <td class="oblog_Btn" TITLE="取消格式" LANGUAGE="javascript" onclick="FormatText('RemoveFormat', '');ondrag='return false;'" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn'; > 
            <img class="oblog_Ico" src="images/removeformat.gif" WIDTH="16" HEIGHT="16" unselectable="on"> </td>
          <td class="oblog_Btn" TITLE="左对齐" NAME="Justify" LANGUAGE="javascript" onclick="FormatText('justifyleft', '');ondrag='return false;'" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn'; > 
            <img class="oblog_Ico" src="images/aleft.gif" WIDTH="16" HEIGHT="16" unselectable="on"> </td>
          <td class="oblog_Btn" TITLE="居中" NAME="Justify" LANGUAGE="javascript" onclick="FormatText('justifycenter', '');ondrag='return false;'" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn'; > 
            <img class="oblog_Ico" src="images/center.gif" WIDTH="16" HEIGHT="16" unselectable="on"> </td>
          <td class="oblog_Btn" TITLE="右对齐" NAME="Justify" LANGUAGE="javascript" onclick="FormatText('justifyright', '');ondrag='return false;'" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn'; > 
            <img class="oblog_Ico" src="images/aright.gif" WIDTH="16" HEIGHT="16" unselectable="on"> </td>
          <td class="oblog_Btn" TITLE="插入表情" LANGUAGE="javascript" onclick="oblog_foremot()" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn'; > 
            <img class="oblog_Ico" src="images/smiley.gif" WIDTH="16" HEIGHT="16" unselectable="on"> </td>
          <td id="forecolor" name=forecolor class="oblog_Btn" TITLE="字体颜色" LANGUAGE="javascript" onclick="oblog_foreColor();" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn'; > 
            <img class="oblog_Ico" src="images/fgcolor.gif" WIDTH="16" HEIGHT="16" unselectable="on" > </td>
          <td id="backcolor" class="oblog_Btn" TITLE="字体背景颜色" LANGUAGE="javascript" onclick="oblog_backColor();ondrag='return false;'" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn';> 
            <img class="oblog_Ico" src="images/fbcolor.gif" WIDTH="16" HEIGHT="16" unselectable="on"> </td>
          <td class="oblog_Btn" TITLE="插入超级链接" LANGUAGE="javascript" onclick="oblog_forlink();ondrag='return false;'" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn'; > 
            <img class="oblog_Ico" src="images/wlink.gif" WIDTH="18" HEIGHT="18" unselectable="on"> </td>
          <td class="oblog_Btn" TITLE="去掉超级链接" LANGUAGE="javascript" onclick="FormatText('Unlink');ondrag='return false;'" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn'; > 
            <img class="oblog_Ico" src="images/unlink.gif" WIDTH="16" HEIGHT="16" unselectable="on"> </td>
          <td class="oblog_Btn" TITLE="清理代码" LANGUAGE="javascript" onclick="oblog_CleanCode();ondrag='return false;'" onmouseover=this.className='oblog_BtnMouseOverUp'; onmouseout=this.className='oblog_Btn';> 
            <img class="oblog_Ico" src="images/cleancode.gif" WIDTH="16" HEIGHT="16"></td>
        </tr>
      </table></tr>
  <tr> 
    <td height="100%" id=PostiFrame> <iframe class="oblog_Composition" ID="oblog_Composition" MARGINHEIGHT="5" MARGINWIDTH="5" width="100%" height="100%"></iframe> </td>
     </tr>
  <tr >
    <td height="20"><TABLE CELLPADDING=0 CELLSPACING=0 BORDER=0 width='100%'>
        <TR>