?? 編程規范與范例(2).htm
字號:
<TD><STRONG><FONT color=#ff0000>博客信息</FONT></STRONG></TD></TR>
<TR bgColor=#ffffff>
<TD>
<P><FONT color=#ff0000>blog名稱:匠人的百寶箱<br>日志總數:1837<br>評論數量:707<br>留言數量:24<br>訪問次數:1352231<br>建立時間:2005年5月18日</FONT></P>
<P align=center><FONT size=3><A href="http://cxjr.21ic.org/" target=_blank><IMG style="BORDER-LEFT-COLOR: #000000; BORDER-BOTTOM-COLOR: #000000; BORDER-TOP-COLOR: #000000; BORDER-RIGHT-COLOR: #000000" src="http://blog.21ic.org/uploadfile-/20051217161245384.gif" border=0></A></FONT></P></TD></TR></TBODY></TABLE></P>
<TD vAlign=top align=middle width=660>
<P align=left>
<TABLE style="TABLE-LAYOUT: fixed; WORD-BREAK: break-all" cellSpacing=1 cellPadding=3 width="100%" bgColor=#cccccc border=0>
<TBODY>
<TR bgColor=#f8f8f8>
<TD><STRONG><FONT color=#ff0000>廣告（2號位）</FONT></STRONG></TD></TR>
<TR bgColor=#ffffff>
<TD>
<DIV align=center>
<ADDRESS> <A href="http://www.3gmcu.com/" target=_blank><IMG style="BORDER-LEFT-COLOR: #000000; BORDER-BOTTOM-COLOR: #000000; BORDER-TOP-COLOR: #000000; BORDER-RIGHT-COLOR: #000000" src="http://blog.21ic.org/uploadfile-/2005122820932375.gif" border=0></A></ADDRESS></DIV></TD></TR></TBODY></TABLE></P>
<P align=left>
<TABLE style="TABLE-LAYOUT: fixed; WORD-BREAK: break-all" cellSpacing=1 cellPadding=3 width="100%" bgColor=#cccccc border=0>
<TBODY>
<TR bgColor=#f8f8f8>
<TD><STRONG><FONT color=#ff0000>酷貼推薦 <FONT color=#ff0000>[</FONT><A href="http://blog.21ic.org/more.asp?name=cxjr&id=7437" target=_blank><U><FONT color=#ff0000>更多…… </FONT></U></A><FONT color=#ff0000>]</FONT></FONT></STRONG></TD></TR>
<TR bgColor=#ffffff>
<TD>
<P align=left>
<TABLE borderColor=#cccccc cellSpacing=2 cellPadding=3 width="100%" bgColor=#ffffff border=1>
<TBODY>
<TR>
<TD>
<P align=center> [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=16591"><U><FONT style="BACKGROUND-COLOR: #ffff00" color=#ff0000>歲月如歌——記匠人的百寶箱博客開通一周年</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=17379"><U><FONT color=#0000ff>事件驅動觀念</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=17377"><U><FONT color=#0000ff>單片機程序設計中運用事件驅動機制</FONT></U></A>]</P></TD>
<TR>
<TD>
<P align=center>[<A href="http://blog.21ic.com/more.asp?name=cxjr&id=18941"><U><FONT color=#0000ff>計算機族必喝的健康飲料</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=18714"><U><FONT color=#0000ff>男人·女人·電腦</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=18713"><U><FONT color=#0000ff>學編程的人不能不看的好文章</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=18742"><U><FONT color=#0000ff>PIC機與MCS-51的區別</FONT></U></A>]</P></TD>
<TR>
<TD>
<P align=center>[<A href="http://blog.21ic.com/more.asp?name=cxjr&id=19794"><U><FONT color=#0000ff>一種軟件去除鍵抖動的方法</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=19752"><U><FONT color=#0000ff>司馬光，你干嘛砸缸？</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=19748"><U><FONT color=#0000ff>編碼規范</FONT></U></A>] </P></TD>
<TR>
<TD>
<P align=center><FONT color=#ff0000>調查：[</FONT><A href="http://21icbbs.com/club/vote/showvote.asp?id=98" target=_blank><U><FONT color=#ff0000>您認為《匠人的百寶箱》如何？</FONT></U></A><FONT color=#ff0000>] [</FONT><A href="http://21icbbs.com/club/vote/showvote.asp?id=129" target=_blank><U><FONT color=#ff0000>您最喜歡《匠人的百寶箱》中哪個欄目？</FONT></U></A><FONT color=#ff0000>] [</FONT><A href="http://blog.21ic.com/more.asp?name=cxjr&id=18993"><U><FONT color=#ff0000>請網友來評選最佳隊員專欄</FONT></U></A><FONT color=#ff0000>]</FONT> </P></TD></TR></TBODY></TABLE></P></TD></TR></TBODY></TABLE></P>
<P align=left>
<TABLE style="TABLE-LAYOUT: fixed; WORD-BREAK: break-all" cellSpacing=1 cellPadding=3 width="100%" bgColor=#cccccc border=0>
<TBODY>
<TR bgColor=#f8f8f8>
<TD>
<P align=left><FONT color=#ff0000 size=4><STRONG><img src=images/face/1.gif ><a href=blog.asp?name=cxjr&subjectid=66>[編程技巧]<a href=more.asp?name=cxjr&id=2755>編程規范與范例(2)</a></STRONG></FONT><BR>程序匠人 2005-8-27 20:15:00 <a href=more.asp?name=cxjr&id=2755>閱讀全文(801)</a> | <a href=more.asp?name=cxjr&id=2755#comment>回復(0)</a> | <a href=showtb.asp?id=2755 target=_blank>引用(0)</a><BR><FONT face=宋體 size=4><STRONG>[</STRONG></FONT><A href="http://blog.21ic.org/more.asp?name=cxjr&id=6250" target=_blank><FONT face=宋體 color=#ff0000 size=4><STRONG>廣告8號位</STRONG></FONT></A><FONT face=宋體 size=4><STRONG>] [</STRONG></FONT><A href="http://blog.21ic.org/more.asp?name=cxjr&id=7705"><U><FONT style="BACKGROUND-COLOR: #000000" face=宋體 color=#ffffff size=4><STRONG>免責聲明</STRONG></FONT></U></A><FONT face=宋體 size=4><STRONG>] [</STRONG><A href="http://blog.21ic.com/more.asp?name=cxjr&id=18993"><U><FONT style="BACKGROUND-COLOR: #ffff00" color=#ff0000 size=3><STRONG>請網友來評選最佳隊員專欄！</STRONG></FONT></U></A><STRONG>]</STRONG></FONT></P></TD></TR>
<TR bgColor=#ffffff>
<TD height=0>
<DIV align=left><P>編程規范與范例(2) <BR>〖文章轉載或出處〗≡中國電子技術信息網≡ 網址：<A href="http://www.CETINet.com">www.CETINet.com</A> <BR>編程規范與范例(2)</P>
<P>目 錄<BR>1 排版 6<BR>2 注釋 11<BR>3 標識符命名 18<BR>4 可讀性 20<BR>5 變量、結構 22<BR>6 函數、過程 28<BR>7 可測性 36<BR>8 程序效率 40<BR>9 質量保證 44<BR>10 代碼編輯、編譯、審查 50<BR>11 代碼測試、維護 52<BR>12 宏 53</P>
<P>3 標識符命名<BR>&sup1; 3-1：標識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產生誤解。<BR>說明：較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個字母形成縮寫；一些單詞有大家公認的縮寫。<BR>示例：如下單詞的縮寫能夠被大家基本認可。<BR>temp 可縮寫為 tmp ;<BR>flag 可縮寫為 flg ;<BR>statistic 可縮寫為 stat ;<BR>increment 可縮寫為 inc ;<BR>message 可縮寫為 msg ;<BR>&sup1; 3-2：命名中若使用特殊約定或縮寫，則要有注釋說明。<BR>說明：應該在源文件的開始之處，對文件中所使用的縮寫或約定，特別是特殊的縮寫，進行必要的注釋說明。<BR>&sup1; 3-3：自己特有的命名風格，要自始至終保持一致，不可來回變化。<BR>說明：個人的命名風格，在符合所在項目組或產品組的命名規則的前提下，才可使用。（即命名規則中沒有規定到的地方才可有個人命名風格）。<BR>&sup1; 3-4：對于變量命名，禁止取單個字符（如i、j、k...），建議除了要有具體含義外，還能表明其變量類型、數據類型等，但i、j、k作局部循環變量是允許的。<BR>說明：變量，尤其是局部變量，如果用單個字符表示，很容易敲錯（如i寫成j），而編譯時又檢查不出來，有可能為了這個小小的錯誤而花費大量的查錯時間。<BR>示例：下面所示的局部變量名的定義方法可以借鑒。<BR>int liv_Width<BR>其變量名解釋如下：<BR>l 局部變量（Local） （其它：g 全局變量（Global）...）<BR>i 數據類型（Interger）<BR>v 變量（Variable） （其它：c 常量（Const）...）<BR>Width 變量含義<BR>這樣可以防止局部變量與全局變量重名。<BR>&sup1; 3-5：命名規范必須與所使用的系統風格保持一致，并在同一項目中統一，比如采用UNIX的全小寫加下劃線的風格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式，用作特殊標識如標識成員變量或全局變量的m_和g_，其后加上大小寫混排的方式是允許的。<BR>示例： Add_User不允許，add_user、AddUser、m_AddUser允許。 <BR>&frac12; 3-1：除非必要，不要用數字或較奇怪的字符來定義標識符。<BR>示例：如下命名，使人產生疑惑。<BR>#define _EXAMPLE_0_TEST_<BR>#define _EXAMPLE_1_TEST_<BR>void set_sls00( BYTE sls );</P>
<P>應改為有意義的單詞命名<BR>#define _EXAMPLE_UNIT_TEST_<BR>#define _EXAMPLE_ASSERT_TEST_<BR>void set_udt_msg_sls( BYTE sls );<BR>&frac12; 3-2：在同一軟件產品內，應規劃好接口部分標識符（變量、結構、函數及常量）的命名，防止編譯、鏈接時產生沖突。<BR>說明：對接口部分的標識符應該有更嚴格限制，防止沖突。如可規定接口部分的變量與常量之前加上“模塊”標識等。<BR>&frac12; 3-3：用正確的反義詞組命名具有互斥意義的變量或相反動作的函數等。<BR>說明：下面是一些在軟件中常用的反義詞組。<BR>add / remove begin / end create / destroy <BR>insert / delete first / last get / release<BR>increment / decrement put / get<BR>add / delete lock / unlock open / close<BR>min / max old / new start / stop<BR>next / previous source / target show / hide<BR>send / receive source / destination<BR>cut / paste up / down<BR>示例：<BR>int min_sum;<BR>int max_sum;<BR>int add_user( BYTE *user_name );<BR>int delete_user( BYTE *user_name );<BR>&frac12; 3-4：除了編譯開關/頭文件等特殊應用，應避免使用_EXAMPLE_TEST_之類以下劃線開始和結尾的定義。<BR> <BR>4 可讀性<BR>&sup1; 4-1：注意運算符的優先級，并用括號明確表達式的操作順序，避免使用默認優先級。<BR>說明：防止閱讀程序時產生誤解，防止因默認的優先級與設計思想不符而導致程序出錯。<BR>示例：下列語句中的表達式<BR>word = (high << 8) | low (1)<BR>if ((a | b) && (a & c)) (2)<BR>if ((a | b) < (c & d)) (3)<BR>如果書寫為<BR>high << 8 | low<BR>a | b && a & c<BR>a | b < c & d<BR>由于<BR>high << 8 | low = ( high << 8) | low,<BR>a | b && a & c = (a | b) && (a & c)，<BR>(1)(2)不會出錯，但語句不易理解；<BR>a | b < c & d = a | （b < c） & d，(3)造成了判斷條件出錯。<BR>&sup1; 4-2：避免使用不易理解的數字，用有意義的標識來替代。涉及物理狀態或者含有物理意義的常量，不應直接使用數字，必須用有意義的枚舉或宏來代替。<BR>示例：如下的程序可讀性差。<BR>if (Trunk[index].trunk_state == 0)<BR>{<BR> Trunk[index].trunk_state = 1;<BR> ... // program code<BR>}</P>
<P>應改為如下形式。<BR>#define TRUNK_IDLE 0<BR>#define TRUNK_BUSY 1</P>
<P>if (Trunk[index].trunk_state == TRUNK_IDLE)<BR>{<BR> Trunk[index].trunk_state = TRUNK_BUSY;<BR> ... // program code<BR>}<BR>&frac12; 4-1：源程序中關系較為緊密的代碼應盡可能相鄰。<BR>說明：便于程序閱讀和查找。<BR>示例：以下代碼布局不太合理。<BR>rect.length = 10;<BR>char_poi = str;<BR>rect.width = 5;</P>
<P>若按如下形式書寫，可能更清晰一些。<BR>rect.length = 10;<BR>rect.width = 5; // 矩形的長與寬關系較密切，放在一起。<BR>char_poi = str;<BR>&frac12; 4-2：不要使用難懂的技巧性很高的語句，除非很有必要時。<BR>說明：高技巧語句不等于高效率的程序，實際上程序的效率關鍵在于算法。<BR>示例：如下表達式，考慮不周就可能出問題，也較難理解。<BR>* stat_poi ++ += 1;</P>
<P>* ++ stat_poi += 1;</P>
<P>應分別改為如下。<BR>*stat_poi += 1;<BR>stat_poi++; // 此二語句功能相當于“ * stat_poi ++ += 1; ”</P>
<P>++ stat_poi;<BR>*stat_poi += 1; // 此二語句功能相當于“ * ++ stat_poi += 1; ”<BR>5 變量、結構<BR>&sup1; 5-1：去掉沒必要的公共變量。<BR>說明：公共變量是增大模塊間耦合的原因之一，故應減少沒必要的公共變量以降低模塊間的耦合度。<BR>&sup1; 5-2：仔細定義并明確公共變量的含義、作用、取值范圍及公共變量間的關系。<BR>說明：在對變量聲明的同時，應對其含義、作用及取值范圍進行注釋說明，同時若有必要還應說明與其它變量的關系。<BR>&sup1; 5-3：明確公共變量與操作此公共變量的函數或過程的關系，如訪問、修改及創建等。<BR>說明：明確過程操作變量的關系后，將有利于程序的進一步優化、單元測試、系統聯調以及代碼維護等。這種關系的說明可在注釋或文檔中描述。<BR>示例：在源文件中，可按如下注釋形式說明。<BR>RELATION System_Init Input_Rec Print_Rec Stat_Score<BR>Student Create Modify Access Access<BR>Score Create Modify Access Access, Modify</P>
<P>注：RELATION為操作關系；System_Init、Input_Rec、Print_Rec、Stat_Score為四個不同的函數；Student、Score為兩個全局變量；Create表示創建，Modify表示修改，Access表示訪問。<BR>其中，函數Input_Rec、Stat_Score都可修改變量Score，故此變量將引起函數間較大的耦合，并可能增加代碼測試、維護的難度。<BR>&sup1; 5-4：當向公共變量傳遞數據時，要十分小心，防止賦與不合理的值或越界等現象發生。<BR>說明：對公共變量賦值時，若有必要應進行合法性檢查，以提高代碼的可靠性、穩定性。<BR>&sup1; 5-5：防止局部變量與公共變量同名。<BR>說明：若使用了較好的命名規則，那么此問題可自動消除。<BR>&sup1; 5-6：嚴禁使用未經初始化的變量作為右值。<BR>說明：特別是在C/C++中引用未經賦值的指針，經常會引起系統崩潰。<BR>&frac12; 5-1：構造僅有一個模塊或函數可以修改、創建，而其余有關模塊或函數只訪問的公共變量，防止多個不同模塊或函數都可以修改、創建同一公共變量的現象。<BR>說明：降低公共變量耦合度。<BR>&frac12; 5-2：使用嚴格形式定義的、可移植的數據類型，盡量不要使用與具體硬件或軟件環境關系密切的變量。<BR>說明：使用標準的數據類型，有利于程序的移植。<BR>示例：如下例子（在DOS下BC3.1環境中），在移植時可能產生問題。<BR>void main()<BR>{<BR> register int index; // 寄存器變量</P>
<P> _AX = 0x4000; // _AX是BC3.1提供的寄存器“偽變量”<BR> ... // program code<BR>}<BR>&frac12; 5-3：結構的功能要單一，是針對一種事務的抽象。<BR>說明：設計結構時應力爭使結構代表一種現實事務的抽象，而不是同時代表多種。結構中的各元素應代表同一事務的不同側面，而不應把描述沒有關系或關系很弱的不同事務的元素放到同一結構中。<BR>示例：如下結構不太清晰、合理。<BR>typedef struct STUDENT_STRU<BR>{<BR> unsigned char name[8]; /* student's name */<BR> unsigned char age; /* student's age */<BR> unsigned char sex; /* student's sex, as follows */<BR> /* 0 - FEMALE; 1 - MALE */<BR> unsigned char <BR> teacher_name[8]; /* the student teacher's name */<BR> unisgned char <BR> teacher_sex; /* his teacher sex */<BR>} STUDENT;</P>
<P>若改為如下，可能更合理些。<BR>typedef struct TEACHER_STRU<BR>{<BR> unsigned char name[8]; /* teacher name */<BR> unisgned char sex; /* teacher sex, as follows */<BR> /* 0 - FEMALE; 1 - MALE */<BR>} TEACHER;</P>
<P>typedef struct STUDENT_STRU<BR>{<BR> unsigned char name[8]; /* student's name */<BR> unsigned char age; /* student's age */<BR> unsigned char sex; /* student's sex, as follows */<BR> /* 0 - FEMALE; 1 - MALE */<BR> unsigned int teacher_ind; /* his teacher index */<BR>} STUDENT;<BR>&frac12; 5-4：不要設計面面俱到、非常靈活的數據結構。<BR>說明：面面俱到、靈活的數據結構反而容易引起誤解和操作困難。<BR>&frac12; 5-5：不同結構間的關系不要過于復雜。<BR>說明：若兩個結構間關系較復雜、密切，那么應合為一個結構。<BR>示例：如下兩個結構的構造不合理。<BR>typedef struct PERSON_ONE_STRU<BR>{<BR> unsigned char name[8];<BR> unsigned char addr[40];<BR> unsigned char sex;<BR> unsigned char city[15];<BR>} PERSON_ONE;</P>
<P>typedef struct PERSON_TWO_STRU<BR>{<BR> unsigned char name[8];<BR> unsigned char age;<BR> unsigned char tel;<BR>} PERSON_TWO;</P>
<P>由于兩個結構都是描述同一事物的，那么不如合成一個結構。<BR>typedef struct PERSON_STRU<BR>{<BR> unsigned char name[8];<BR> unsigned char age;<BR> unsigned char sex;<BR> unsigned char addr[40];<BR> unsigned char city[15];<BR> unsigned char tel;<BR>} PERSON;<BR>&frac12; 5-6：結構中元素的個數應適中。若結構中元素個數過多可考慮依據某種原則把元素組成不同的子結構，以減少原結構中元素的個數。<BR>說明：增加結構的可理解性、可操作性和可維護性。<BR>示例：假如認為如上的_PERSON結構元素過多，那么可如下對之劃分。<BR>typedef struct PERSON_BASE_INFO_STRU<BR>{<BR> unsigned char name[8];<BR> unsigned char age;<BR> unsigned char sex;<BR>} PERSON_BASE_INFO;</P>
<P>typedef struct PERSON_ADDRESS_STRU<BR>{<BR> unsigned char addr[40];<BR> unsigned char city[15];<BR> unsigned char tel;<BR>} PERSON_ADDRESS;</P>
<P>typedef struct PERSON_STRU<BR>{<BR> PERSON_BASE_INFO person_base;<BR> PERSON_ADDRESS person_addr;<BR>} PERSON;<BR>&frac12; 5-7：仔細設計結構中元素的布局與排列順序，使結構容易理解、節省占用空間，并減少引起誤用現象。<BR>說明：合理排列結構中元素順序，可節省空間并增加可理解性。<BR>示例：如下結構中的位域排列，將占較大空間，可讀性也稍差。<BR>typedef struct EXAMPLE_STRU<BR>{<BR> unsigned int valid: 1;<BR> PERSON person;<BR> unsigned int set_flg: 1;<BR>} EXAMPLE;</P>
<P>若改成如下形式，不僅可節省1字節空間，可讀性也變好了。<BR>typedef struct EXAMPLE_STRU<BR>{<BR> unsigned int valid: 1;<BR> unsigned int set_flg: 1;<BR> PERSON person ;<BR>} EXAMPLE;<BR>&frac12; 5-8：結構的設計要盡量考慮向前兼容和以后的版本升級，并為某些未來可能的應用保留余地（如預留一些空間等）。<BR>說明：軟件向前兼容的特性，是軟件產品是否成功的重要標志之一。如果要想使產品具有較好的前向兼容，那么在產品設計之初就應為以后版本升級保留一定余地，并且在產品升級時必須考慮前一版本的各種特性。<BR>&frac12; 5-9：留心具體語言及編譯器處理不同數據類型的原則及有關細節。<BR>說明：如在C語言中，static局部變量將在內存“數據區”中生成，而非static局部變量將在“堆棧”中生成。這些細節對程序質量的保證非常重要。<BR>&frac12; 5-10：編程時，要注意數據類型的強制轉換。<BR>說明：當進行數據類型強制轉換時，其數據的意義、轉換后的取值等都有可能發生變化，而這些細節若考慮不周，就很有可能留下隱患。<BR>&frac12; 5-11：對編譯系統默認的數據類型轉換，也要有充分的認識。<BR>示例：如下賦值，多數編譯器不產生告警，但值的含義還是稍有變化。<BR>char chr;<BR>unsigned short int exam;</P>
?? 快捷鍵說明
復制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -