一、軟件編碼-簡(jiǎn)介
隨著軟件產(chǎn)品的功能增添和版本的提高，代碼越來(lái)越龐雜，源文件也越來(lái)越多， 對(duì)濟(jì)南軟件開(kāi)發(fā)人員來(lái)說(shuō)，除了保證程序運(yùn)行的正確性和提高代碼的運(yùn)行效率之外，規(guī)范風(fēng)格的編碼會(huì)對(duì)軟件的升級(jí)、修改、維護(hù)帶來(lái)極大的方便性，也保證程序員不會(huì)陷入“代碼泥潭”中無(wú)奈自拔。開(kāi)發(fā)一個(gè)成熟的軟件產(chǎn)品，除了有詳細(xì)豐盛的開(kāi)發(fā)文檔之外，必需在編寫(xiě)代碼的時(shí)候就井井有條，過(guò)細(xì)謹(jǐn)嚴(yán)。
以下的編碼標(biāo)準(zhǔn)包括了程序排版、解釋、命名、可讀性、變量、程序效力、品質(zhì)保障、代碼編譯、代碼測(cè)試跟版本把持等留神事項(xiàng)。
二、編碼規(guī)則-排版要求：
1.要害詞和操作符之間加適當(dāng)?shù)目崭瘛?/p>
2.絕對(duì)獨(dú)破的程序塊與塊之間加空行
3.較長(zhǎng)的語(yǔ)句、表達(dá)式等要分成多行書(shū)寫(xiě)。
4.劃分出的新行要進(jìn)行適應(yīng)的縮進(jìn)，使排版整潔，語(yǔ)句可讀。
5.長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首。
6.循環(huán)、判斷等語(yǔ)句中若有較長(zhǎng)的表白式或語(yǔ)句，則要進(jìn)行適應(yīng)的劃分。
7.若函數(shù)或進(jìn)程中的參數(shù)較長(zhǎng)，則要進(jìn)行恰當(dāng)?shù)膭澐帧?/p>
8.不容許把多個(gè)短語(yǔ)句寫(xiě)在一行中，即一行只寫(xiě)一條語(yǔ)句。
9.函數(shù)或過(guò)程的開(kāi)端、結(jié)構(gòu)的定義及循環(huán)、判斷等語(yǔ)句中的代碼都要采取縮進(jìn)風(fēng)格。
10.C/C++語(yǔ)言是用大括號(hào)‘{’和‘}’界定一段程序塊的，編寫(xiě)程序塊時(shí)‘{’和‘}’應(yīng)各獨(dú)有一行并且位于同一列，同時(shí)與引用它們的語(yǔ)句左對(duì)齊。在函數(shù)體的開(kāi)始、類(lèi)的定義、結(jié)構(gòu)的定義、枚舉的定義以及if、for、do、while、switch、case語(yǔ)句中的程序都要采用如上的縮進(jìn)方式。
三、編碼規(guī)則-注釋注意事項(xiàng)
1.注釋要簡(jiǎn)略明了。
2.邊寫(xiě)代碼邊注釋?zhuān)薷拇a同時(shí)修改相應(yīng)的注釋?zhuān)员ＷC注釋與代碼的一致性。
3.在必要的處所注釋?zhuān)⑨屃恳m中。注釋的內(nèi)容要明白、明了，含義精確，防止注釋二義性。堅(jiān)持注釋與其描述的代碼相鄰，即注釋的就近原則。
4.對(duì)代碼的正文應(yīng)放在其上方相鄰地位，不可放在下面。
5.對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋?xiě)?yīng)放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注解應(yīng)放在此域的右方；統(tǒng)一構(gòu)造中不同域的注釋要對(duì)齊。
6.變量、常量的注釋?xiě)?yīng)放在其上方相鄰位置或右方。
7.全局變量要有較具體的注釋?zhuān)▽?duì)其功能、取值規(guī)模、哪些函數(shù)或過(guò)程存取它以及存取時(shí)注意事項(xiàng)等的闡明。
8.在每個(gè)源文件的頭部要有必要的注釋信息，包含：文件名；版本號(hào)；作者；天生日期；模塊功能描寫(xiě)（如功能、重要算法、內(nèi)部各局部之間的關(guān)系、該文件與其它文件關(guān)系等）；主要函數(shù)或過(guò)程清單及本文件歷史修改記載等。
9.在每個(gè)函數(shù)或過(guò)程的前面要有必要的注釋信息，包括：函數(shù)或過(guò)程名稱(chēng)；功能描述；輸入、輸出及返回值說(shuō)明；調(diào)用關(guān)系及被調(diào)用關(guān)系說(shuō)明等。
四、編碼規(guī)則-命名方法
1.較短的單詞可通從前掉“元音”構(gòu)成縮寫(xiě)；
2.較長(zhǎng)的單詞可取單詞的頭多少發(fā)符的優(yōu)先級(jí)，并用括號(hào)明確抒發(fā)式的操作次序，避免使用默認(rèn)優(yōu)先級(jí)。
3.使用匈牙利表現(xiàn)法
五、編碼規(guī)則-可讀性方面
1.避免使用不易理解的數(shù)字，用有意思的標(biāo)識(shí)來(lái)替換。
2.不要使用難懂的技能性很高的語(yǔ)句。
3.源程序中關(guān)系較為嚴(yán)密的代碼應(yīng)盡可能相鄰。
六、編碼規(guī)則-變量設(shè)置
1.去掉沒(méi)必要的公共變量。
2.構(gòu)造僅有一個(gè)模塊或函數(shù)可以修改、創(chuàng)建，而其余有關(guān)模塊或函數(shù)只訪問(wèn)的公共變量，防止多個(gè)不同模塊或函數(shù)都可以修改、創(chuàng)建同一公共變量的現(xiàn)象。
3.細(xì)心定義并明白公共變量的含意、作用、取值范疇及公共變量間的關(guān)系。
4.明確公共變量與操作此公共變量的函數(shù)或過(guò)程的關(guān)系，如拜訪、修正及創(chuàng)立等。
5.當(dāng)向公共變量傳遞數(shù)據(jù)時(shí)，要非常警惕，防止賦與分歧理的值或越界等景象產(chǎn)生。
6.預(yù)防局部變量與公共變量同名。
7.仔細(xì)設(shè)計(jì)結(jié)構(gòu)中元素的布局與排列順序，使結(jié)構(gòu)容易懂得、節(jié)儉占用空間，并減少引起誤用現(xiàn)象。
8.結(jié)構(gòu)的設(shè)計(jì)要盡量斟酌向前兼容和當(dāng)前的版本進(jìn)級(jí)，并為某些將來(lái)可能的利用保存余地（如預(yù)留一些空間等）。
9.留心詳細(xì)語(yǔ)言及編譯器處理不同數(shù)據(jù)類(lèi)型的原則及有關(guān)細(xì)節(jié)。
10.嚴(yán)禁使用未經(jīng)初始化的變量。申明變量的同時(shí)對(duì)變量進(jìn)行初始化。
11.編程時(shí)，要注意數(shù)據(jù)類(lèi)型的強(qiáng)迫轉(zhuǎn)換。
七、編碼規(guī)則-函數(shù)、過(guò)程
1.函數(shù)的范圍盡量限度在200行以?xún)?nèi)。
2.一個(gè)函數(shù)最好僅實(shí)現(xiàn)一件功能。
3.為簡(jiǎn)單功能編寫(xiě)函數(shù)。
4.函數(shù)的功能應(yīng)當(dāng)是能夠猜測(cè)的，也就是只有輸入數(shù)據(jù)相同就應(yīng)發(fā)生同樣的輸出。
5.盡量不要編寫(xiě)依附于其余函數(shù)內(nèi)部實(shí)現(xiàn)的函數(shù)。
6.避免設(shè)計(jì)多參數(shù)函數(shù)，不使用的參數(shù)從接口中去掉。
7.用注釋詳細(xì)解釋每個(gè)參數(shù)的作用、取值范圍及參數(shù)間的關(guān)系。
8.檢討函數(shù)所有參數(shù)輸入的有效性。
9.檢查函數(shù)所有非參數(shù)輸入的有效性，如數(shù)據(jù)文件、公共變量等。
10.函數(shù)名應(yīng)正確描述函數(shù)的功能。
11.避免使用無(wú)意義或含義不清的動(dòng)詞為函數(shù)命名
12.函數(shù)的返回值要清晰、明了，讓使用者不輕易疏忽過(guò)錯(cuò)情形。
13/明確函數(shù)功能，準(zhǔn)確（而不是近似）地實(shí)現(xiàn)函數(shù)設(shè)計(jì)。
14.減少函數(shù)本身或函數(shù)間的遞歸調(diào)用。
15.編寫(xiě)可重入函數(shù)時(shí)，若使用全局變量，則應(yīng)通過(guò)關(guān)中止、信號(hào)量（即P、V操作）等手段對(duì)其加以維護(hù)。
八、編碼規(guī)則-可測(cè)性
1.在編寫(xiě)代碼之前，應(yīng)預(yù)先設(shè)計(jì)好程序調(diào)試與測(cè)試的方式和手腕，并設(shè)計(jì)好各種調(diào)測(cè)開(kāi)關(guān)及相應(yīng)測(cè)試代碼如打印函數(shù)等。
2.在進(jìn)行集成測(cè)試/系統(tǒng)聯(lián)調(diào)之前，要結(jié)構(gòu)好測(cè)試環(huán)境、測(cè)試項(xiàng)目及測(cè)試用例，同時(shí)仔細(xì)剖析并優(yōu)化測(cè)試用例，以進(jìn)步測(cè)試效率。
九、編碼規(guī)則-程序效率
1.編程時(shí)要常常注意代碼的效率。
2.在保證軟件系統(tǒng)的正確性、穩(wěn)定性、可讀性及可測(cè)性的條件下，提高代碼效率。
3.不能一味地尋求代碼效率，而對(duì)軟件的準(zhǔn)確性、穩(wěn)定性、可讀性及可測(cè)性造成影響。
4.編程時(shí)，要隨時(shí)留意代碼效率；優(yōu)化代碼時(shí)，要考慮周全。
5.要仔細(xì)地構(gòu)造或直接用匯編編寫(xiě)調(diào)用頻繁或機(jī)能要求極高的函數(shù)。
6.通過(guò)對(duì)系統(tǒng)數(shù)據(jù)結(jié)構(gòu)劃分與組織的改良，以及對(duì)程序算法的優(yōu)化來(lái)提高空間效率。
7.在多重循環(huán)中，應(yīng)將最忙的循環(huán)放在最內(nèi)層。
8.盡量減少循環(huán)嵌套檔次。
9.防止輪回體內(nèi)含判定語(yǔ)句，應(yīng)將循環(huán)語(yǔ)句置于斷定語(yǔ)句的代碼塊之中。
10.盡量用乘法或其它辦法取代除法，特殊是浮點(diǎn)運(yùn)算中的除法。
十、編碼規(guī)則-質(zhì)量保證
1.在軟件設(shè)計(jì)過(guò)程中構(gòu)筑軟件質(zhì)量。
代碼質(zhì)量保證優(yōu)先準(zhǔn)則
（1）正確性，指程序要實(shí)現(xiàn)設(shè)計(jì)要求的功能。
（2）穩(wěn)固性、保險(xiǎn)性，指程序穩(wěn)定、牢靠、平安。
（3）可測(cè)試性，指程序要存在良好的可測(cè)試性。
（4）規(guī)范/可讀性，指程序書(shū)寫(xiě)作風(fēng)、命名規(guī)矩等要合乎規(guī)范。
（5）全局效率，指軟件系統(tǒng)的整體效率。
（6）部分效率，指某個(gè)模塊/子模塊/函數(shù)的自身效率。
（7）個(gè)人表達(dá)方法/個(gè)人方便性，指?jìng)€(gè)人編程習(xí)慣。
2.只引用屬于本人的存貯空間。
3.防止引用已經(jīng)開(kāi)釋的內(nèi)存空間。
4.過(guò)程/函數(shù)中調(diào)配的內(nèi)存，在過(guò)程/函數(shù)退出之前要釋放。
5.過(guò)程/函數(shù)中申請(qǐng)的（為打開(kāi)文件而使用的）文件句柄，在過(guò)程/函數(shù)退出前要封閉。
6.防止內(nèi)存操作越界。
7.時(shí)刻注意表達(dá)式是否會(huì)上溢、下溢。
8.當(dāng)真處置程序所能碰到的各種犯錯(cuò)情況。
9.體系運(yùn)行之初，要初始化有關(guān)變量及運(yùn)行環(huán)境，避免未經(jīng)初始化的變量被援用。
10.系統(tǒng)運(yùn)行之初，要對(duì)加載到系統(tǒng)中的數(shù)據(jù)進(jìn)行一致性檢查。
11.嚴(yán)禁隨意更改其它模塊或系統(tǒng)的有關(guān)設(shè)置和配置。
12.不能隨便轉(zhuǎn)變與其它模塊的接口。
13.充足懂得系統(tǒng)的接口之后，再使用系統(tǒng)供給的功效。
14.要時(shí)刻注意易混雜的操作符。當(dāng)編完程序后，應(yīng)從頭至尾檢查一遍這些操作符。
15.不使用與硬件或操作系統(tǒng)關(guān)聯(lián)很大的語(yǔ)句，而使用倡議的尺度語(yǔ)句。
16.提議：使用第三方提供的濟(jì)南軟件開(kāi)發(fā)工具包或控件時(shí)，要注意以下幾點(diǎn)：
（1）充分了解運(yùn)用接口、使用環(huán)境及使用時(shí)注意事項(xiàng)。
（2）不能過(guò)火信任其正確性。
（3）除非必要，不要使用不熟習(xí)的第三方工具包與控件。
十一、編碼規(guī)則-代碼編譯
1.編寫(xiě)代碼時(shí)要注意隨時(shí)保留，并按期備份，防止因?yàn)閿嚯?、硬盤(pán)破壞等起因造成代碼喪失。
2.同一名目組內(nèi)，最好使用相同的編纂器,濟(jì)南IOS開(kāi)發(fā)，并使用雷同的設(shè)置選項(xiàng)。
3.公道地設(shè)計(jì)軟件系統(tǒng)目錄，便利開(kāi)發(fā)職員應(yīng)用。
4.翻開(kāi)編譯器的所有告警開(kāi)關(guān)對(duì)程序進(jìn)行編譯。
5.在同一項(xiàng)目組或產(chǎn)品組中，要同一編譯開(kāi)關(guān)選項(xiàng)。
6.使用工具軟件（如Visual SourceSafe）對(duì)代碼版本進(jìn)行保護(hù)。
十二、編碼規(guī)則-代碼測(cè)試、維護(hù)
1.單元測(cè)試請(qǐng)求至少到達(dá)語(yǔ)句籠罩。
2.單元測(cè)試開(kāi)始要跟蹤每一條語(yǔ)句，并察看數(shù)據(jù)流及變量的變更。
3.清算、收拾或優(yōu)化后的代碼要經(jīng)由審查及測(cè)試。
4.代碼版本升級(jí)要經(jīng)過(guò)嚴(yán)厲測(cè)試。
