?? c語言編碼規范.htm
字號:
<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=15191>C語言編碼規范</a></STRONG></FONT><BR>程序匠人 2006-4-28 20:46:00 <a href=more.asp?name=cxjr&id=15191>閱讀全文(1329)</a> | <a href=more.asp?name=cxjr&id=15191#comment>回復(1)</a> | <a href=showtb.asp?id=15191 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><H2>C語言編碼規范</H2><BR><FONT size=2>原創作者：Jerry</FONT><BR><FONT size=2>轉載請注明：來自Sawin系統分析之窗</FONT><BR><FONT size=2>最后修改時間：2005-7-20<FONT size=+0><BR><BR><FONT size=2> </FONT><BR>
<P>
<P><B><SPAN style="FONT-SIZE: 36pt; FONT-FAMILY: 宋體; mso-bidi-font-size: 9.0pt; mso-bidi-font-family: Arial; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA">C<SPAN lang=ZH-CN>語言編碼規范</SPAN></SPAN></B></P><SPAN style="FONT-SIZE: 36pt; FONT-FAMILY: 宋體; mso-bidi-font-size: 9.0pt; mso-bidi-font-family: Arial; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA"><SPAN lang=ZH-CN>
<H2><A name=_Toc109124033></A><A name=_Toc109629211><FONT size=3>A.1 </FONT></A><FONT size=3>排版</FONT></H2>
<DIV><FONT size=3>1-1：程序塊要采用縮進風格編寫，縮進的TAB鍵一個。<BR>1-2：相對獨立的程序塊之間、變量說明之后必須加空行。<BR>1-3：較長的語句（>80字符）要分成多行書寫，長表達式要在低優先級操作符處劃分新行，操作符放在新行之首，劃分出的新行要進行適當的縮進，使排版整齊，語句可讀。<BR>1-4：循環、判斷等語句中若有較長的表達式或語句，則要進行適應的劃分，長表達式要在低優先級操作符處劃分新行，操作符放在新行之首。<BR>1-5：若函數或過程中的參數較長，則要進行適當的劃分。<BR>1-6：不允許把多個短語句寫在一行中，即一行只寫一條語句。 <BR>1-7：if、while、for、default、do等語句自占一行。<BR>1-8：對齊只使用TAB鍵，不使用空格鍵。<BR>1-9：函數或過程的開始、結構的定義及循環、判斷等語句中的代碼都要采用縮進風格，case語句下的情況處理語句也要遵從語句縮進要求。<BR>1-10：程序塊的分界符（如C/C++語言的大括號'{'和'}'）應各獨占一行并且位于同一列，同時與引用它們的語句左對齊。在函數體的開始、類的定義、結構的定義、枚舉的定義以及if、for、do、while0、switch、case語句中的程序都要采用如上的縮進方式。<BR>1-11：在兩個以上的關鍵字、變量、常量進行對等操作時，它們之間的操作符之前、之后或者前后要加空格；進行非對等操作時，如果是關系密切的立即操作符（如－>），后不應加空格。<BR>1-12: 程序結構清析，簡單易懂，單個函數的程序行數不得超過100行。</FONT></DIV>
<H2><A name=_Toc109124034></A><A name=_Toc109629212><FONT size=3>A.2 </FONT></A><FONT size=3>注釋</FONT></H2>
<DIV><FONT size=3>2-1：一般情況下，源程序有效注釋量必須在20％以上。<BR>2-2：說明性文件（如頭文件.h文件、.inc文件、.def文件、編譯說明文件.cfg等）頭部應進行注釋，注釋必須列出：版權說明、版本號、生成日期、作者、內容、功能、與其它文件的關系、修改日志等，頭文件的注釋中還應有函數功能簡要說明。<BR>2-3：源文件頭部應進行注釋，列出：版權說明、版本號、生成日期、作者、模塊目的/功能、主要函數及其功能、修改日志等。 <BR>2-4：函數頭部應進行注釋，列出：函數的目的/功能、輸入參數、輸出參數、返回值、調用關系（函數、表）等。<BR>2-5：邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。不再有用的注釋要刪除。<BR>2-6：注釋的內容要清楚、明了，含義準確，防止注釋二義性。<BR>2-7：避免在注釋中使用縮寫，特別是非常用縮寫。<BR>2-8：注釋應與其描述的代碼相近，對代碼的注釋應放在其上方或右方（對單條語句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。<BR>2-9：對于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時都必須加以注釋，說明其物理含義。變量、常量、宏的注釋應放在其上方相鄰位置或右方。<BR>2-10：數據結構聲明(包括數組、結構、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。對數據結構的注釋應放在其上方相鄰位置，不可放在下面；對結構中的每個域的注釋放在此域的右方。<BR>2-11：全局變量要有較詳細的注釋，包括對其功能、取值范圍、哪些函數或過程存取它以及存取時注意事項等的說明。<BR>2-12：注釋與所描述內容進行同樣的縮排。<BR>2-13：將注釋與其上面的代碼用空行隔開。<BR>2-14：對變量的定義和分支語句（條件分支、循環語句等）必須編寫注釋。<BR>2-15：對于switch語句下的case語句，如果因為特殊情況需要處理完一個case后進入下一個case處理，必須在該case語句處理完、下一個case語句前加上明確的注釋。</FONT></DIV>
<H2><A name=_Toc109124035></A><A name=_Toc109629213><FONT size=3>A.3 </FONT></A><FONT size=3>標識符命名</FONT></H2>
<DIV><FONT size=3>3-1：標識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產生誤解。<BR>3-2：命名中若使用特殊約定或縮寫，則要有注釋說明。<BR>3-3：自己特有的命名風格，要自始至終保持一致，不可來回變化。<BR>3-4：對于變量命名，禁止取單個字符（如i、j、k...），建議除了要有具體含義外，還能表明其變量類型、數據類型等，但i、j、k作局部循環變量是允許的。<BR>3-5：命名規范必須與所使用的系統風格保持一致，并在同一項目中統一，比如采用UNIX的全小寫加下劃線的風格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式。</FONT></DIV>
<H2><A name=_Toc109124036></A><A name=_Toc109629214><FONT size=3>A.4 </FONT></A><FONT size=3>可讀性</FONT></H2>
<DIV><FONT size=3>4-1：注意運算符的優先級，并用括號明確表達式的操作順序，避免使用默認優先級。<BR>4-2：避免使用不易理解的數字，用有意義的標識來替代。涉及物理狀態或者含有物理意義的常量，不應直接使用數字，必須用有意義的枚舉或宏來代替。</FONT></DIV>
<H2><A name=_Toc109124037></A><A name=_Toc109629215><FONT size=3>A.5 </FONT></A><FONT size=3>變量</FONT></H2>
<DIV><FONT size=3>5-1：去掉沒必要的公共變量。<BR>5-2：仔細定義并明確公共變量的含義、作用、取值范圍及公共變量間的關系。<BR>5-3：明確公共變量與操作此公共變量的函數或過程的關系，如訪問、修改及創建等。<BR>5-4：當向公共變量傳遞數據時，要十分小心，防止賦與不合理的值或越界等現象發生。<BR>5-5：防止局部變量與公共變量同名。<BR>5-6：嚴禁使用未經初始化的變量作為右值。</FONT></DIV>
<H2><A name=_Toc109124038></A><A name=_Toc109629216><FONT size=3>A.6 </FONT></A><FONT size=3>函數、過程</FONT></H2>
<DIV><FONT size=3>6-1：對所調用函數的錯誤返回碼要仔細、全面地處理。<BR>6-2：明確函數功能，精確（而不是近似）地實現函數設計。<BR>6-3：編寫可重入函數時，應注意局部變量的使用(如編寫C/C++語言的可重入函數時，應使用auto即缺省態局部變量或寄存器變量)。<BR>6-4：編寫可重入函數時，若使用全局變量，則應通過關中斷、信號量（即P、V操作）等手段對其加以保護。</FONT></DIV>
<H2><A name=_Toc109124039></A><A name=_Toc109629217><FONT size=3>A.7 </FONT></A><FONT size=3>可測性</FONT></H2>
<DIV><FONT size=3>7-1：在同一項目組或產品組內，要有一套統一的為集成測試與系統聯調準備的調測開關及相應打印函數，并且要有詳細的說明。<BR>7-2：在同一項目組或產品組內，調測打印出的信息串的格式要有統一的形式。信息串中至少要有所在模塊名（或源文件名）及行號。<BR>7-3：編程的同時要為單元測試選擇恰當的測試點，并仔細構造測試代碼、測試用例，同時給出明確的注釋說明。測試代碼部分應作為（模塊中的）一個子模塊，以方便測試代碼在模塊中的安裝與拆卸（通過調測開關）。<BR>7-4：在進行集成測試/系統聯調之前，要構造好測試環境、測試項目及測試用例，同時仔細分析并優化測試用例，以提高測試效率。<BR>7-5：使用斷言來發現軟件問題，提高代碼可測性。<BR>7-6：用斷言來檢查程序正常運行時不應發生但在調測時有可能發生的非法情況。<BR>7-7：不能用斷言來檢查最終產品肯定會出現且必須處理的錯誤情況。<BR>7-8：對較復雜的斷言加上明確的注釋。<BR>7-9：用斷言確認函數的參數。<BR>7-10：用斷言保證沒有定義的特性或功能不被使用。<BR>7-11：用斷言對程序開發環境（OS/Compiler/Hardware）的假設進行檢查。<BR>7-12：正式軟件產品中應把斷言及其它調測代碼去掉（即把有關的調測開關關掉）。<BR>7-13：在軟件系統中設置與取消有關測試手段，不能對軟件實現的功能等產生影響。<BR>7-14：用調測開關來切換軟件的DEBUG版和正式版，而不要同時存在正式版本和DEBUG版本的不同源文件，以減少維護的難度。<BR>7-15：軟件的DEBUG版本和發行版本應該統一維護，不允許分家，并且要時刻注意保證兩個版本在實現功能上的一致性。</FONT></DIV>
<H2><A name=_Toc109124040></A><A name=_Toc109629218><FONT size=3>A.8 </FONT></A><FONT size=3>程序效率</FONT></H2>
<DIV><FONT size=3>8-1：編程時要經常注意代碼的效率。<BR>8-2：在保證軟件系統的正確性、穩定性、可讀性及可測性的前提下，提高代碼效率。<BR>8-3：局部效率應為全局效率服務，不能因為提高局部效率而對全局效率造成影響。<BR>8-4：通過對系統數據結構的劃分與組織的改進，以及對程序算法的優化來提高空間效率。<BR>8-5：循環體內工作量最小化。</FONT></DIV>
<H2><A name=_Toc109124041></A><A name=_Toc109629219><FONT size=3>A.9 </FONT></A><FONT size=3>質量保證</FONT></H2>
<DIV><FONT size=3>9-1：在軟件設計過程中構筑軟件質量。<BR>9-2：代碼質量保證優先原則<BR>9-3：只引用屬于自己的存貯空間。<BR>9-4：防止引用已經釋放的內存空間。<BR>9-5：過程/函數中分配的內存，在過程/函數退出之前要釋放。<BR>9-6：過程/函數中申請的(為打開文件而使用的)文件句柄，在過程/函數退出之前要關閉。 <BR>9-7：防止內存操作越界。<BR>9-8：認真處理程序所能遇到的各種出錯情況。<BR>9-9：系統運行之初，要初始化有關變量及運行環境，防止未經初始化的變量被引用。<BR>9-10：系統運行之初，要對加載到系統中的數據進行一致性檢查。<BR>9-11：嚴禁隨意更改其它模塊或系統的有關設置和配置。<BR>9-12：不能隨意改變與其它模塊的接口。<BR>9-13：充分了解系統的接口之后，再使用系統提供的功能。<BR>9-14：編程時，要防止差1錯誤。<BR>9-15：要時刻注意易混淆的操作符。當編完程序后，應從頭至尾檢查一遍這些操作符，以防止拼寫錯誤。<BR>9-16：有可能的話，if語句盡量加上else分支，對沒有else分支的語句要小心對待；switch語句必須有default分支。<BR>9-17： 禁止GOTO語句。<BR>9-18：單元測試也是編程的一部份，提交聯調測試的程序必須通過單元測試。</FONT></DIV>
<H2><A name=_Toc109124042></A><A name=_Toc109629220><FONT size=3>A.10 </FONT></A><FONT size=3>代碼編輯、編譯、審查</FONT></H2>
<DIV><FONT size=3>10-1：打開編譯器的所有告警開關對程序進行編譯。<BR>10-2：在產品軟件（項目組）中，要統一編譯開關選項。<BR>10-3：通過代碼走讀及審查方式對代碼進行檢查。</FONT></DIV>
<H2><A name=_Toc109124043></A><A name=_Toc109629221><FONT size=3>A.11 </FONT></A><FONT size=3>代碼測試、維護</FONT></H2>
<DIV><FONT size=3>11-1：單元測試要求至少達到語句覆蓋。<BR>11-2：單元測試開始要跟蹤每一條語句，并觀察數據流及變量的變化。<BR>11-3：清理、整理或優化后的代碼要經過審查及測試。<BR>11-4：代碼版本升級要經過嚴格測試。<BR>11-5：使用工具軟件對代碼版本進行維護。<BR>11-6：正式版本上軟件的任何修改都應有詳細的文檔記錄。</FONT></DIV>
<H2><A name=_Toc109124044></A><A name=_Toc109629222><FONT size=3>A.12 </FONT></A><FONT size=3>宏</FONT></H2>
<P><FONT size=3>12-1：用宏定義表達式時，要使用完備的括號。<BR>12-2:將宏所定義的多條表達式放在大括號中。<BR>12-3:使用宏時，不允許參數發生變化</FONT></SPAN></SPAN></P>
<P></P><!--Here is the bottom-->
<P> </P><FONT size=2>【作者介紹】 <B>Jerry</B></FONT><BR><BR><FONT size=2>97年畢業于北京某高校計算級專業，先后在軟件公司和網絡公司從事軟件開發，系統分析和設計工作。2001年涉及軟件質量保證，先后擔任測試工程師，測試部經理，副經理。精通軟件工程和測試流程，精通RUP, CMM, ISO, 6SIGMA軟件質量保證工作。</FONT><BR><FONT size=2>作者Email地址：xianggu@yahoo.com</FONT></FONT></FONT></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>
<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>回復:C語言編碼規范<a name='8191'></a></STRONG></FONT><BR>的(游客) 2006-5-10 13:32:00 個人主頁 | <a href=more.asp?name=cxjr&id=15191&commentid=8191#comment>引用</a> | <a href='#top'>返回</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>萬維網</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><div align=right> <font face=webdings color='red'>9</font> <b> <font color='red'>1</font> </b><font face=webdings color='red'>:</font></div><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=15191&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' /> <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='回復:C語言編碼規范'><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>
?? 快捷鍵說明
復制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -