?? 編程規(guī)范與范例(1).htm
字號:
<P> /* code two comments */<BR> CodeBlock Two<BR>}<BR>&sup1; 2-13：將注釋與其上面的代碼用空行隔開。<BR>示例：如下例子，顯得代碼過于緊湊。<BR>/* code one comments */<BR>program code one<BR>/* code two comments */<BR>program code two</P>
<P>應(yīng)如下書寫<BR>/* code one comments */<BR>program code one</P>
<P>/* code two comments */<BR>program code two<BR>&sup1; 2-14：對變量的定義和分支語句（條件分支、循環(huán)語句等）必須編寫注釋。<BR>說明：這些語句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵，對于維護(hù)人員來說，良好的注釋幫助更好的理解程序，有時甚至優(yōu)于看設(shè)計文檔。<BR>&sup1; 2-15：對于switch語句下的case語句，如果因?yàn)樘厥馇闆r需要處理完一個case后進(jìn)入下一個case處理，必須在該case語句處理完、下一個case語句前加上明確的注釋。<BR>說明：這樣比較清楚程序編寫者的意圖，有效防止無故遺漏break語句。<BR>示例（注意斜體加粗部分）：<BR>case CMD_UP: <BR> ProcessUp(); <BR> break;</P>
<P>case CMD_DOWN: <BR> ProcessDown(); <BR> break;</P>
<P>case CMD_FWD: <BR> ProcessFwd(); <BR> <BR>if (...)<BR>{<BR> ...<BR> break;<BR>}<BR>else<BR>{<BR> ProcessCFW_B(); // now jump into case CMD_A<BR>}</P>
<P>case CMD_A: <BR> ProcessA(); <BR> break;</P>
<P>case CMD_B: <BR> ProcessB(); <BR> break;</P>
<P>case CMD_C: <BR> ProcessC(); <BR> break;</P>
<P>case CMD_D: <BR> ProcessD(); <BR> break;<BR>...<BR>&frac12; 2-1：避免在一行代碼或表達(dá)式的中間插入注釋。<BR>說明：除非必要，不應(yīng)在代碼或表達(dá)中間插入注釋，否則容易使代碼可理解性變差。<BR>&frac12; 2-2：通過對函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的。<BR>說明：清晰準(zhǔn)確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。<BR>&frac12; 2-3：在代碼的功能、意圖層次上進(jìn)行注釋，提供有用、額外的信息。<BR>說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復(fù)注釋信息。<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>&frac12; 2-4：在程序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序塊的結(jié)束。<BR>說明：當(dāng)代碼段較長，特別是多重嵌套時，這樣做可以使代碼更清晰，更便于閱讀。<BR>示例：參見如下例子。<BR>if (...)<BR>{<BR> // program code</P>
<P> while (index < MAX_INDEX)<BR> {<BR> // program code<BR> } /* end of while (index < MAX_INDEX) */ // 指明該條while語句結(jié)束<BR>} /* end of if (...)*/ // 指明是哪條if語句結(jié)束<BR>&frac12; 2-5：注釋格式盡量統(tǒng)一，建議使用“/* …… */”。<BR>&frac12; 2-6：注釋應(yīng)考慮程序易讀及外觀排版的因素，使用的語言若是中、英兼有的，建議多使用中文，除非能用非常流利準(zhǔn)確的英文表達(dá)。<BR>說明：注釋語言不統(tǒng)一，影響程序易讀性和外觀排版，出于對維護(hù)人員的考慮，建議使用中文。<BR> <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>發(fā)表評論：</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' >驗(yàn)證碼：<input name='GetCode' type='text' id='GetCode' size='12' maxlength='20' /> <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' >標(biāo)題：<input name='commenttopic' type='text' id='commenttopic' size='42' maxlength='50' value='回復(fù):編程規(guī)范與范例(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>
?? 快捷鍵說明
復(fù)制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -