【正文】 移植性和可重用性 7提供良好的接口界面 7系統(tǒng)具有一定容錯(cuò)能力 75方法 7認(rèn)真處理程序所能遇到的各種出錯(cuò)情況 7系統(tǒng)運(yùn)行之初，要初始化有關(guān)變量及運(yùn)行環(huán)境，防止未經(jīng)初始化的變量被引用 7系統(tǒng)運(yùn)行之初，要對(duì)加載到系統(tǒng)中的數(shù)據(jù)進(jìn)行一致性檢查 7嚴(yán)禁隨意更改其它模塊或系統(tǒng)的有關(guān)設(shè)置和配置 7不能隨意改變與其它模塊的接口 7防止內(nèi)存操作越界 7編程時(shí)，要防止差1錯(cuò)誤 7要時(shí)刻注意易混淆的操作符 7條件判斷語(yǔ)句必須處理所有情況 7不要用goto語(yǔ)句 7盡量都采用標(biāo)準(zhǔn)語(yǔ)句和標(biāo)準(zhǔn)庫(kù)函數(shù) 7避免使用嵌入式匯編 7精心構(gòu)造算法，并對(duì)其性能、效率進(jìn)行測(cè)試 7對(duì)較關(guān)鍵的算法最好使用其它算法來(lái)確認(rèn) 7時(shí)刻注意表達(dá)式是否會(huì)上溢、下溢 7使用變量時(shí)要注意其邊界值的情況 7注意程序代碼是否超過(guò)系統(tǒng)有關(guān)限制 7循環(huán)、分支層次不要超過(guò)五層 7不要比較浮點(diǎn)數(shù)的相等 7關(guān)注共用體的存儲(chǔ)、對(duì)齊模式 7頭文件中不應(yīng)有對(duì)象或函數(shù)的定義 7不應(yīng)單獨(dú)使用小寫(xiě)字母“l(fā)”或大寫(xiě)字母“O”作為變量名 7函數(shù)聲明時(shí)參數(shù)不應(yīng)只有類(lèi)型名沒(méi)有標(biāo)識(shí)符 7不應(yīng)對(duì)有符號(hào)數(shù)進(jìn)行位運(yùn)算 7無(wú)格式的字符型不應(yīng)與負(fù)數(shù)常量和零比較 7無(wú)符號(hào)值不應(yīng)與負(fù)數(shù)常量比較 7對(duì)變量進(jìn)行移位操作應(yīng)保證不會(huì)產(chǎn)生溢出和數(shù)據(jù)截短 7不應(yīng)在布爾表達(dá)式中使用賦值操作符 7不應(yīng)對(duì)布爾表達(dá)式進(jìn)行算術(shù)或者位運(yùn)算 7表達(dá)式的值在任何求值順序下應(yīng)保持一致 7應(yīng)避免除數(shù)可能為0的情況出現(xiàn) 7賦值運(yùn)算符的左操作數(shù)不應(yīng)進(jìn)行轉(zhuǎn)換操作，并且應(yīng)該是一個(gè)可更改的對(duì)象 7sizeof操作符不應(yīng)用在有單邊作用的表達(dá)式上 7留心具體語(yǔ)言及編譯器處理不同數(shù)據(jù)類(lèi)型的原則及有關(guān)細(xì)節(jié) 80十二、代碼代碼編輯、編譯、審查 80打開(kāi)編譯器的所有告警開(kāi)關(guān)對(duì)程序進(jìn)行編譯 80在產(chǎn)品軟件（項(xiàng)目組）中，要統(tǒng)一編譯開(kāi)關(guān)選項(xiàng) 80通過(guò)代碼走讀及審查方式對(duì)代碼進(jìn)行檢查 80測(cè)試部測(cè)試產(chǎn)品之前，應(yīng)對(duì)代碼進(jìn)行抽查及評(píng)審 80養(yǎng)成隨時(shí)保存編寫(xiě)代碼的習(xí)慣 80同產(chǎn)品軟件（項(xiàng)目組）內(nèi)，最好使用相同的編輯器，并使用相同的設(shè)置選項(xiàng) 80要小心地使用編輯器提供的塊拷貝功能編程 80合理地設(shè)計(jì)軟件系統(tǒng)目錄，方便開(kāi)發(fā)人員使用 80附錄A 常用數(shù)據(jù)類(lèi)型及簡(jiǎn)寫(xiě) 81附錄B 常用單詞及縮寫(xiě) 82附錄C 常見(jiàn)反義詞組 84附錄D 常見(jiàn)命名規(guī)則 86一、匈牙利命名法 86二、駱駝（Camel）命名法 86三、帕斯卡（Pascal）命名法 86四、下劃線命名法 86第一章、項(xiàng)目模塊劃分一、模塊劃分將整個(gè)項(xiàng)目按照功能進(jìn)行模塊劃分，各個(gè)模塊相互獨(dú)立，每個(gè)模塊由一系列c文件和h文件組成。簡(jiǎn)單功能的模塊采用一個(gè)c文件和h文件接口，復(fù)雜功能的模塊可能需要多個(gè)c文件和h文件。二、模塊命名按照模塊所實(shí)現(xiàn)功能的英文名稱(chēng)或者簡(jiǎn)寫(xiě)命名，全部采用小寫(xiě)字母，多于1個(gè)單詞的中間加下劃線。例如：模塊命名說(shuō)明液晶 液晶初始化，字符、漢字和圖片顯示 液晶自定義字庫(kù)按鍵 按鍵初始化，鍵值列表，取按鍵值指示燈 指示燈初始化，閃爍控制數(shù)碼管數(shù)碼管初始化，數(shù)字顯示，特殊字符顯示蜂鳴器蜂鳴器初始化，鳴叫控制第二章、文件格式一、c文件格式說(shuō)明：文件創(chuàng)建及修改說(shuō)明區(qū)主要包含：公司信息：公司名稱(chēng)、公司網(wǎng)站。創(chuàng)建信息：創(chuàng)建者名稱(chēng)，創(chuàng)建日期，最初版本號(hào)，文檔內(nèi)容描述。修改信息：修改者名稱(chēng)，修改日期，修改后版本號(hào)，修改內(nèi)容描述?？蓞⒖寄K《》說(shuō)明：與硬件相關(guān)的文件可以在此增加說(shuō)明，如芯片型號(hào)等。頭文件引用區(qū)主要包含：系統(tǒng)頭文件引用：文件名包含在尖括號(hào)中。自定義頭文件引用：文件名包含著雙引號(hào)中?？蓞⒖寄K《》全局變量定義區(qū)主要包含：全局變量定義區(qū)說(shuō)明注釋行：全局變量定義：要賦初值。全局變量注釋?zhuān)嚎蓞⒖寄K《》。驅(qū)動(dòng)函數(shù)區(qū)主要包含：驅(qū)動(dòng)函數(shù)區(qū)說(shuō)明注釋行：函數(shù)說(shuō)明：包含函數(shù)說(shuō)明，參數(shù)說(shuō)明，返回值說(shuō)明。函數(shù)體： 可參考模塊《》應(yīng)用函數(shù)區(qū)主要包含：應(yīng)用函數(shù)區(qū)說(shuō)明注釋行：函數(shù)說(shuō)明：包含函數(shù)功能說(shuō)明，參數(shù)說(shuō)明，返回值說(shuō)明。函數(shù)體： 可參考模塊《》文件結(jié)束說(shuō)明主要包含：文件結(jié)束說(shuō)明：End Of File可參考模塊《》二、h文件格式說(shuō)明文件創(chuàng)建及修改說(shuō)明區(qū)主要包含：公司信息：公司名稱(chēng)、公司網(wǎng)站。創(chuàng)建信息：創(chuàng)建者名稱(chēng)，創(chuàng)建日期，最初版本號(hào)，文檔內(nèi)容描述。修改信息：修改者名稱(chēng)，修改日期，修改后版本號(hào)，修改內(nèi)容描述?？蓞⒖寄K《》防重調(diào)用定義命名規(guī)則：下劃線+文件名大寫(xiě)+下劃線+文件類(lèi)型H+下劃線可參考模塊《》頭文件引用主要包含：系統(tǒng)頭文件引用：文件名包含在尖括號(hào)中。自定義頭文件引用：文件名包含著雙引號(hào)中。可參考模塊《》控制接口定義區(qū)主要包含：控制口線定義區(qū)說(shuō)明注釋行：接口定義：全部采用大寫(xiě)字母，單詞間以下劃線分割注釋說(shuō)明：可參考模塊《》常量定義區(qū)主要包含：常量定義區(qū)說(shuō)明注釋行：常量定義：全部采用大寫(xiě)字母，單詞間以下劃線分割注釋說(shuō)明：可參考模塊《》宏調(diào)用定義區(qū)主要包含：宏調(diào)用定義區(qū)說(shuō)明注釋行：宏調(diào)用處理： 注釋說(shuō)明： 可參考模塊《》類(lèi)型定義區(qū)主要包含：類(lèi)型定義區(qū)說(shuō)明注釋行：類(lèi)型定義： 注釋說(shuō)明：結(jié)構(gòu)體成員要單獨(dú)說(shuō)明?？蓞⒖寄K《》外部引用變量區(qū)主要包含：外部應(yīng)用變量區(qū)說(shuō)明注釋行：引用變量聲明：以extern關(guān)鍵字開(kāi)始注釋說(shuō)明：可參考模塊《》外部引用函數(shù)區(qū)主要包含：外部應(yīng)用函數(shù)區(qū)說(shuō)明注釋行：函數(shù)注釋說(shuō)明：包含函數(shù)功能說(shuō)明，參數(shù)說(shuō)明，返回值說(shuō)明引用函數(shù)聲明：以extern關(guān)鍵字開(kāi)始可參考模塊《》操作流程說(shuō)明區(qū)主要包含：操作流程說(shuō)明區(qū)說(shuō)明注釋行：模塊執(zhí)行流程說(shuō)明：說(shuō)明要詳細(xì)，執(zhí)行步驟要明確?？蓞⒖寄K《》1文件結(jié)束說(shuō)明主要包含：文件結(jié)束說(shuō)明：End Of File可參考模塊《》第三章、命名規(guī)則一、函數(shù)命名規(guī)則格式如下：序號(hào)說(shuō)明字體選擇備注1模塊名稱(chēng)大寫(xiě)必選以最直觀模式給用戶(hù)區(qū)分不同的模塊函數(shù)，采用模塊英文名稱(chēng)或者簡(jiǎn)寫(xiě)2下劃線必選間隔符3函數(shù)動(dòng)作首字母大寫(xiě)必選動(dòng)作英文名稱(chēng)或者簡(jiǎn)寫(xiě)，最多2個(gè)單詞4函數(shù)對(duì)象首字母大寫(xiě)可選對(duì)象英文名稱(chēng)或者簡(jiǎn)寫(xiě)，最多2個(gè)單詞5函數(shù)范圍首字母大寫(xiě)可選范圍英文名稱(chēng)或者簡(jiǎn)寫(xiě)，最多2個(gè)單詞例如：LCD_DispWord，表示液晶模塊顯示漢字 函數(shù)命名的一個(gè)重要原則是望文知意（其他人看到函數(shù)名就大體知道函數(shù)功能），必須考慮命名的準(zhǔn)確性，命名體現(xiàn)函數(shù)的功能，而不要體現(xiàn)函數(shù)的實(shí)現(xiàn)方法。二、變量命名規(guī)則局部變量命名：格式如下：序號(hào)說(shuō)明字體選擇備注1變量類(lèi)型簡(jiǎn)寫(xiě)小寫(xiě)必選以最直觀模式給用戶(hù)區(qū)分不同的變量類(lèi)型，最多2個(gè)字母長(zhǎng)度，具體參考《附錄A 常用變量類(lèi)型及簡(jiǎn)寫(xiě)》2變量修飾首字母大寫(xiě)可選修飾詞英文名稱(chēng)或者簡(jiǎn)寫(xiě)，最多2個(gè)單詞3變量名稱(chēng)首字母大寫(xiě)必選名稱(chēng)英文名稱(chēng)或者簡(jiǎn)寫(xiě)，最多2個(gè)單詞例如：uchar ucCurrentValue。 表示無(wú)符號(hào)類(lèi)型，當(dāng)前值數(shù)組變量命名時(shí)在局部變量類(lèi)型前增加前綴字母“a”。例如：uchar aucSendBuff[10]。指針變量命名時(shí)在局部變量類(lèi)型前增加前綴字母“p”。例如：uchar *pucReceiveBuff[10]。全局變量命名時(shí)在局部變量類(lèi)型前增加前綴字母“g”和下劃線。靜態(tài)變量命名時(shí)在局部變量類(lèi)型前增加前綴字母“s”和下劃線。三、宏命名規(guī)則格式如下：序號(hào)說(shuō)明字體選擇備注1模塊名稱(chēng)大寫(xiě)必選以最直觀模式給用戶(hù)區(qū)分不同的模塊宏，采用模塊英文名稱(chēng)或者簡(jiǎn)寫(xiě)2下劃線必選間隔符3功能名稱(chēng)大寫(xiě)必選功能英文名稱(chēng)或者簡(jiǎn)寫(xiě)，最多2個(gè)單詞4下劃線可選間隔符5修飾詞大寫(xiě)可選修飾詞英文名稱(chēng)或者簡(jiǎn)寫(xiě)，最多2個(gè)單詞例如：define TMP_BUFF_MAX 256 //緩沖區(qū)最大長(zhǎng)度四、文件命名規(guī)則格式如下（全部小寫(xiě)）：序號(hào)說(shuō)明字體選擇備注1模塊名稱(chēng)小寫(xiě)必選采用模塊英文名稱(chēng)或者簡(jiǎn)寫(xiě)2下劃線可選_3分類(lèi)名稱(chēng)小寫(xiě)可選分類(lèi)英文名稱(chēng)或者簡(jiǎn)寫(xiě)4頓號(hào)必選.5文件類(lèi)型小寫(xiě)必選代碼文件（c），頭文件（h）例如：液晶模塊： 按鍵模塊： 五、新定義變量類(lèi)型命名規(guī)則 新定義變量類(lèi)型對(duì)變量進(jìn)行命名時(shí)可以提出2個(gè)與其他類(lèi)型不相同的字母前綴來(lái)表示，并在文件開(kāi)始或者新類(lèi)型定義時(shí)進(jìn)行說(shuō)明。六、命名注意事項(xiàng)：標(biāo)識(shí)符命名基本原則標(biāo)識(shí)符的命名要清晰、明了，有明確含義，同時(shí)使用完整的單詞或大家基本可以理解的縮寫(xiě)，避免使人產(chǎn)生誤解。盡量采用英文命名，不可以用漢語(yǔ)拼音。標(biāo)識(shí)符的長(zhǎng)度應(yīng)當(dāng)符合“minlength amp。amp。 maxinformation”原則。說(shuō)明：較短的單詞可通過(guò)去掉“元音”形成縮寫(xiě)；較長(zhǎng)的單詞可取單詞的頭幾個(gè)字母形成縮寫(xiě)；一些單詞有大家公認(rèn)的縮寫(xiě)。參考《附錄B 常用單詞及縮寫(xiě)》命名中若使用特殊約定或縮寫(xiě)，則要有注釋說(shuō)明說(shuō)明：應(yīng)該在源文件的開(kāi)始之處，對(duì)文件中所使用的縮寫(xiě)或約定，特別是特殊的縮寫(xiě)，進(jìn)行必要的注釋說(shuō)明。局部循環(huán)變量也必須按照變量命名規(guī)則來(lái)定義說(shuō)明：變量，尤其是局部變量，如果用單個(gè)字符表示，很容易敲錯(cuò)（如i寫(xiě)成j），而編譯時(shí)又檢查不出來(lái)，有可能為了這個(gè)小小的錯(cuò)誤而花費(fèi)大量的查錯(cuò)時(shí)間。不要用數(shù)字或較奇怪的字符來(lái)定義標(biāo)識(shí)符 示例：如下命名，使人產(chǎn)生疑惑。define EXAMPLE_0_TESTdefine EXAMPLE_1_TESTvoid TMP_SetSls00( uchar ucSls )。應(yīng)改為有意義的單詞命名define EXAMPLE_UNIT_TESTdefine EXAMPLE_ASSERT_TESTvoid TMP_SetUdtMsgSls(uchar ucSls )。用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(shù)等說(shuō)明：可參考《附錄C 常見(jiàn)反義詞組》下面是一些在軟件中常用的反義詞組。示例：uint uiMinSum。uint uiMaxSum。uint TMP_AddUser( uchar *pucUserName )。uint TMP_DeleteUser(uchar *pucUserName )。避免使用以下劃線開(kāi)始和結(jié)尾的定義 除了編譯開(kāi)關(guān)/頭文件等特殊應(yīng)用，應(yīng)避免使用_EXAMPLE_TEST_之類(lèi)以下劃線開(kāi)始和結(jié)尾的定義程序中不要出現(xiàn)僅靠大小寫(xiě)區(qū)分的相似的標(biāo)識(shí)符 例如：　　uint　uix,　uiX?！　　　? // 變量x 與 X 容易混淆　　void TMP_foo(uint uiX)?！　?/ 函數(shù)foo 與FOO容易混淆　　void TMP_FOO(float fX)。標(biāo)識(shí)符縮寫(xiě)命名時(shí)盡量不使用單詞縮寫(xiě)，如果單詞太長(zhǎng)必須縮寫(xiě)，應(yīng)該省略其中的元音字母，以便望文知意，如packet_header縮寫(xiě)為pkt_hdr，而不要縮寫(xiě)為pack_h。常用單詞縮寫(xiě)見(jiàn)《附錄B 常用單詞及縮寫(xiě)》函數(shù)名應(yīng)準(zhǔn)確描述函數(shù)的功能避免使用無(wú)意義或含義不清的動(dòng)詞為函數(shù)命名 說(shuō)明：避免用含義不清的動(dòng)詞如process、handle等為函數(shù)命名，因?yàn)檫@些動(dòng)詞并沒(méi)有說(shuō)明要具體做什么。第四章、代碼書(shū)寫(xiě)規(guī)范一、基本原則 制定規(guī)范的基本目的就是加強(qiáng)代碼的可維護(hù)性，也就是說(shuō)代碼必須易于閱讀，易于理解，易于測(cè)試，易于移植。所有的代碼必須采用ANSI C，標(biāo)準(zhǔn)函數(shù)原型必須采用ANSI C 標(biāo)準(zhǔn)。保持代碼語(yǔ)句和結(jié)構(gòu)簡(jiǎn)單清晰，避免使用復(fù)雜語(yǔ)句。二、排版縮進(jìn)風(fēng)格 程序塊要采用縮進(jìn)風(fēng)格編寫(xiě)，縮進(jìn)的空格數(shù)為4個(gè)。預(yù)處理語(yǔ)句、全局?jǐn)?shù)據(jù)、函數(shù)原型、標(biāo)題、附加說(shuō)明、函數(shù)說(shuō)明、標(biāo)號(hào)等均頂格書(shū)寫(xiě)。語(yǔ)句塊的“{”“}”配對(duì)對(duì)齊，并與其前一行對(duì)齊。不要使用【TAB】鍵 【TAB】鍵在不同編輯器和打印機(jī)上因所設(shè)置空格數(shù)目不同而造成程序布局不整齊，從而導(dǎo)致代碼縮排混亂?？梢圆捎每崭矜I來(lái)替代，4個(gè)空格代替一個(gè)【TAB】鍵。 如果采用Source Insight軟件，可以設(shè)置按【TAB】鍵后自動(dòng)用4個(gè)空格鍵替代?？招? 相對(duì)獨(dú)立的程序塊之間、變量說(shuō)明之后必須加空行。程序文件結(jié)構(gòu)各部分之間空兩行，若不必要也可只空一行，各函數(shù)實(shí)現(xiàn)之間一般空兩行 示例：如下例子不符合規(guī)范。if ((ucCount == 1) amp。amp。 (ucRetCode == 1)){ if (ucStatus == 39。139。) { *pucErrCode = 0。 return EPRONTCENTER。