程序設(shè)計語言編碼規(guī)范江蘇微軟技術(shù)中心編碼規(guī)范之函數(shù)過程與審查編譯第六章

教學(xué)內(nèi)容

函數(shù)的編碼規(guī)范。審查與編譯的編碼規(guī)范。函數(shù)規(guī)范1.明確函數(shù)功能，精確（而不是近似）地實現(xiàn)函數(shù)設(shè)計。按照詳細(xì)設(shè)計，實現(xiàn)函數(shù)的功能。函數(shù)規(guī)范2.方法的命名第一個單詞一般是動詞。第一個字母是小寫，但是中間單詞的第一個字母是大寫。

函數(shù)規(guī)范在同一項目組應(yīng)明確規(guī)定對接口函數(shù)參數(shù)的合法性檢查應(yīng)由函數(shù)的調(diào)用者負(fù)責(zé)還是由接口函數(shù)本身負(fù)責(zé)，缺省是由函數(shù)調(diào)用者負(fù)責(zé)。說明：對于模塊間接口函數(shù)的參數(shù)的合法性檢查這一問題，往往有兩個極端現(xiàn)象，即：要么是調(diào)用者和被調(diào)用者對參數(shù)均不作合法性檢查，結(jié)果就遺漏了合法性檢查這一必要的處理過程，造成問題隱患；要么就是調(diào)用者和被調(diào)用者均對參數(shù)進(jìn)行合法性檢查，這種情況雖不會造成問題，但產(chǎn)生了冗余代碼，降低了效率。函數(shù)規(guī)范防止將函數(shù)的參數(shù)作為工作變量。說明：將函數(shù)的參數(shù)作為工作變量，有可能錯誤地改變參數(shù)內(nèi)容，所以很危險。對必須改變的參數(shù)，最好先用局部變量代之，最后再將該局部變量的內(nèi)容賦給該參數(shù)。函數(shù)規(guī)范函數(shù)的規(guī)模盡量限制在200行以內(nèi)說明：不包括注釋和空格行。函數(shù)規(guī)范為簡單功能編寫函數(shù)說明：雖然為僅用一兩行就可完成的功能去編函數(shù)好象沒有必要，但用函數(shù)可使功能明確化，增加程序可讀性，亦可方便維護(hù)、測試。示例：如下語句的功能不很明顯。value=(a>b)?a:b;改為如下就很清晰了。intmax(inta,intb){

return((a>b)?a:b);}value=max(a,b);函數(shù)規(guī)范函數(shù)的功能應(yīng)該是可以預(yù)測的，也就是只要輸入數(shù)據(jù)相同就應(yīng)產(chǎn)生同樣的輸出。說明：如函數(shù)內(nèi)部使用了全局變量或靜態(tài)變量。當(dāng)其它代碼修改了該全局或靜態(tài)變量時，該函數(shù)在內(nèi)部運(yùn)算時使用到該值發(fā)生改變，將不會得到預(yù)期的結(jié)果。這是一個典型的在語法上是正確的。但是在應(yīng)用中確不可使用的方法。函數(shù)規(guī)范避免設(shè)計多參數(shù)函數(shù)，不使用的參數(shù)從接口中去掉。說明：目的減少函數(shù)間接口的復(fù)雜度。函數(shù)規(guī)范檢查函數(shù)所有參數(shù)輸入的有效性。函數(shù)名應(yīng)準(zhǔn)確描述函數(shù)的功能。函數(shù)規(guī)范使用動賓詞組為執(zhí)行某操作的函數(shù)命名。如果是OOP方法，可以只有動詞（名詞是對象本身）。示例：參照如下方式命名函數(shù)。voidprint_record(int

rec_ind);函數(shù)規(guī)范在調(diào)用函數(shù)填寫參數(shù)時，應(yīng)盡量減少沒有必要的數(shù)據(jù)類型轉(zhuǎn)換或強(qiáng)制數(shù)據(jù)類型轉(zhuǎn)換。說明：因為數(shù)據(jù)類型轉(zhuǎn)換或多或少存在危險。函數(shù)規(guī)范避免函數(shù)中不必要語句，防止程序中的垃圾代碼。程序中的垃圾代碼不僅占用額外的空間，而且還常常影響程序的功能與性能，很可能給程序的測試、維護(hù)等造成不必要的麻煩。函數(shù)規(guī)范減少函數(shù)本身或函數(shù)間的遞歸調(diào)用。說明：遞歸調(diào)用特別是函數(shù)間的遞歸調(diào)用（如A->B->C->A），影響程序的可理解性；遞歸調(diào)用一般都占用較多的系統(tǒng)資源（如棧空間）；遞歸調(diào)用對程序的測試有一定影響。故除非為某些算法或功能的實現(xiàn)方便，應(yīng)減少沒必要的遞歸調(diào)用。函數(shù)規(guī)范當(dāng)一個過程（函數(shù)）中對較長變量（一般是結(jié)構(gòu)的成員）有較多引用時，可以用一個意義相當(dāng)?shù)暮甏?。說明：這樣可以增加編程效率和程序的可讀性。示例：在某過程中較多引用TheReceiveBuffer[FirstSocket].byDataPtr

則可以通過以下宏定義來代替：#definepSOCKDATATheReceiveBuffer[FirstScoket].byDataPtr審查規(guī)范１.在產(chǎn)品軟件（項目組）中，要統(tǒng)一編譯開關(guān)選項。２.通過代碼走讀及審查方式對代碼進(jìn)行檢查。３.測試部測試產(chǎn)品之前，應(yīng)對代碼進(jìn)行抽查及評審。審查規(guī)范４.單元測試要求至少達(dá)到語句覆蓋。５.單元測試開始要跟蹤每一條語句，并觀察數(shù)據(jù)流及變量的變化。６.正式版本上軟件的任何修改都應(yīng)有詳細(xì)的文檔記錄。本章總結(jié)函數(shù)規(guī)范精確實現(xiàn)功能用動詞（動賓）作方法名參數(shù)檢查不要改變參數(shù)值不超過２００行為簡單邏輯功能編寫函數(shù)輸出可預(yù)期去掉無用參數(shù)檢查輸入有效性函數(shù)