代碼總體原則
成都網(wǎng)站建設(shè)哪家好，找成都創(chuàng)新互聯(lián)公司！專注于網(wǎng)頁設(shè)計、網(wǎng)站建設(shè)公司、微信開發(fā)、微信小程序開發(fā)、集團企業(yè)網(wǎng)站設(shè)計等服務(wù)項目。核心團隊均擁有互聯(lián)網(wǎng)行業(yè)多年經(jīng)驗，服務(wù)眾多知名企業(yè)客戶；涵蓋的客戶類型包括：成都陽光房等眾多領(lǐng)域，積累了大量豐富的經(jīng)驗，同時也獲得了客戶的一致贊許！
清晰第一。清晰性是易于維護、易于重構(gòu)的程序必須具備的特征。
簡潔為美。簡介就是易于理解并且易于實現(xiàn)。
選擇合適的風(fēng)格，與源代碼風(fēng)格保持一致。
頭文件
頭文件的設(shè)計體現(xiàn)了大部分的系統(tǒng)設(shè)計，不合理的頭文件布局是編譯時間過長的根因，實際上是不合理的設(shè)計。
頭文件中適合放置接口的聲明，不適合放置實現(xiàn)。
頭文件應(yīng)當(dāng)職責(zé)單一。
頭文件應(yīng)向穩(wěn)定的方向包含。
每一個.c文件應(yīng)有一個同名的.h文件，用于聲明需要對外公開的接口。
禁止頭文件循環(huán)依賴。
禁止包含用不到的頭文件。
頭文件應(yīng)當(dāng)自包含。
編寫內(nèi)部#include保護符(#define保護)。
禁止在頭文件中定義變量。
只能通過包含頭文件的方式使用其他C提供的接口，禁止在C中通過extern的方式使用外部函數(shù)接口和變量。
禁止在extern "C"中包含頭文件。
函數(shù)
函數(shù)設(shè)計的精髓：編寫整潔函數(shù)，同事把代碼有效組織起來。
一個函數(shù)僅完成一個功能。
重復(fù)代碼應(yīng)該盡可能提煉成函數(shù)。
避免函數(shù)過長，新增函數(shù)不超過50行。
避免函數(shù)的代碼塊嵌套過深，新增函數(shù)的代碼塊嵌套不超過4層。
可重入函數(shù)應(yīng)避免使用共享變量；若需要使用，則應(yīng)該通過互斥手段對其加以保護。
對參數(shù)的合法性檢查，由調(diào)用者負(fù)責(zé)還是接口函數(shù)負(fù)責(zé)，應(yīng)在項目組模塊內(nèi)統(tǒng)一規(guī)定。缺省由調(diào)用者負(fù)責(zé)。
對函數(shù)的錯誤返回碼要全面處理。
設(shè)計高扇入，合理扇出（小于7）的函數(shù)。扇出是指調(diào)用其它函數(shù)的數(shù)目。扇入是指有多少上級函數(shù)調(diào)用它。
廢棄代碼要及時清除。
函數(shù)參數(shù)不變使用const限定。
函數(shù)應(yīng)避免使用全局變量、靜態(tài)局部變量和I/O操作，不可避免的地方應(yīng)集中使用。
檢查函數(shù)所有非參數(shù)輸入的有效性，如數(shù)據(jù)文件、公共變量等。
函數(shù)的參數(shù)個數(shù)不超過5個。
在源文件范圍內(nèi)聲明和定義的所有函數(shù)，除非外部可見，否則應(yīng)該加static關(guān)鍵字。
標(biāo)識符
標(biāo)識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解。
產(chǎn)品、項目組內(nèi)應(yīng)保持同意的命名分格。
盡量避免名字中出現(xiàn)數(shù)字編號，除非邏輯上確實需要。
重構(gòu)、修改部分代碼時，應(yīng)該保持和原有代碼風(fēng)格一致。
文件命令統(tǒng)一采用小寫字符。因為不同系統(tǒng)對文件名大小寫處理會有不同（windows不區(qū)分大小寫，但是linux系統(tǒng)則區(qū)分）。
全局變量應(yīng)增加“g_”前綴。
靜態(tài)變量應(yīng)增加“s_”前綴。
禁止使用單字節(jié)命名變量，但是允許定義i,j,k作為局部循環(huán)變量。
不建議使用匈牙利命名法。
對于數(shù)值或者字符串常量的定義，建議采用全大寫字母，單詞之間加下劃線的方式命名。
變量
結(jié)構(gòu)功能單一，不要設(shè)計面面俱到的數(shù)據(jù)結(jié)構(gòu)。
不用或者少用全局變量
防止局部變量與全局變量同名
通訊過程中使用的機構(gòu)，必須注意字節(jié)序。
嚴(yán)禁使用未經(jīng)初始化的變量作為右值。
使用面向接口編程思想，通過API訪問數(shù)據(jù)。
盡量減少沒有必要的數(shù)據(jù)類型默認(rèn)轉(zhuǎn)換與強制轉(zhuǎn)換。
宏和常量
用宏定義表達式時，要使用完備的括號。
將宏定義的多條表達式放在大括號中。
使用宏時，不允許參數(shù)發(fā)生變化。
不允許直接使用魔鬼數(shù)字。
除非必要，應(yīng)盡可能使用函數(shù)代替宏。
常量建議用const定義代替宏。
質(zhì)量
時刻注意易混淆的操作符
必須了解編譯系統(tǒng)的內(nèi)存分配方式，特別是編譯系統(tǒng)對不同類型的變量的內(nèi)存分配規(guī)則，如局部變量在何處分配、靜態(tài)變量在何處分配等。
不僅關(guān)注接口，同樣要關(guān)注實現(xiàn)。
禁止內(nèi)存操作越界。
禁止內(nèi)存泄漏。
禁止引用已經(jīng)釋放的內(nèi)存空間。
編程時，要防止差1錯誤。
switch語句必須有default分支。
函數(shù)中分配的內(nèi)存，在函數(shù)退出之前要釋放。
不要濫用goto語句。
時刻注意表達式是否會上溢、下溢。
程序效率
在保證軟件系統(tǒng)的正確性、簡潔、可維護性、可靠性及可測試性的前提下，提高代碼的效率。
通過對數(shù)據(jù)結(jié)構(gòu)、程序算法的優(yōu)化來提高效率。
將不變條件的計算移到循環(huán)體外。
對于多維大數(shù)組，避免來回跳躍式訪問數(shù)組成員。
創(chuàng)建資源庫，以減少分配對象的開銷。
將多次被調(diào)用的“小函數(shù)”改為inline函數(shù)或者宏實現(xiàn)。
注釋
優(yōu)秀的代碼可以自我解釋，不通過注釋即可輕易讀懂。
注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。
修改代碼時，維護代碼周邊的所有注釋，以保證注釋與代碼的一致性。不再有用的注釋要刪除。
文件頭部應(yīng)進行注釋，注釋需要列出：版權(quán)說明、版本號、生成日期、作者姓名、工號、內(nèi)容、功能說明、與其他文件的關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能的說明。
函數(shù)聲明處注釋描述函數(shù)功能、性能及用法，包括輸入和輸出參數(shù)、函數(shù)返回值、可重入的要求等；定義處詳細描述函數(shù)功能和實現(xiàn)要點，如實現(xiàn)的簡要步驟、實現(xiàn)的理由、設(shè)計約束等。
全局變量要有詳細的注釋，包括對其功能、取值范圍以及存取時注意事項等的說明。
盡量采用工具可以識別的格式注釋。
排版與格式
程序塊采用縮進風(fēng)格編寫，每級縮進為4個空格。
相對獨立的程序塊之間、變量說明之后必須加空行。
一行只寫一條語句。
對等操作兩邊加空格，注釋符與內(nèi)容之間加空格。
編譯
使用編譯器的最高告警級別，理解所有的告警，通過修改代碼而不是降低告警級別來消除所有告警。
在產(chǎn)品軟件中，要統(tǒng)一編譯開關(guān)、靜態(tài)檢查選項以及相應(yīng)告警清除策略。
可測性
模塊劃分清晰，接口明確，耦合性小，有明確輸入和輸出，否則單元測試實施困難。
在統(tǒng)一項目組或產(chǎn)品組內(nèi)，調(diào)測打印的日志要有統(tǒng)一的規(guī)定。
使用斷言記錄內(nèi)部假設(shè)。
不能用斷言來檢查運行時錯誤。
華為技術(shù)有限公司內(nèi)部技術(shù)規(guī)范
DKBA 2826-2011.5
C語言編程規(guī)范
鏈接在此，自己下載吧：
剛?cè)腴TGo語言小白需要注意以下五點：
1、注意書寫代碼的一些規(guī)范吧，特別是注意大小寫、英文標(biāo)點符號區(qū)別等，在特別的位置寫上注釋。
2、主要是理解偽代碼所描述的算法，偽代碼要注意是不能直接運行的。
3、注意編譯器版本與書籍上所介紹版本是否一致，也注意特殊符號，印刷版本可能與實際不一致。
4、書上的版本和當(dāng)前所用的版本是否一致，有些情況下書上版本在現(xiàn)在來用已經(jīng)過時了。
5、邏輯走通;給自己信心，其實起步階段不難的。
華為編程規(guī)范舉例：
1-1：程序塊要采用縮進風(fēng)格編寫，縮進的空格數(shù)為4個。
說明：對于由開發(fā)工具自動生成的代碼可以有不一致。
1-2：相對獨立的程序塊之間、變量說明之后必須加空行。
1-3：較長的語句（80字符）要分成多行書寫，長表達式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首，劃分出的新行要進行適當(dāng)?shù)目s進，使排版整齊，語句可讀。
1-4：不允許把多個短語句寫在一行中，即一行只寫一條語句。
1-5：if、for、do、while、case、switch、default等語句自占一行，且if、for、do、while等語句的執(zhí)行語句部分無論多少都要加括號{}。
1-6：對齊只使用空格鍵，不使用TAB鍵。
說明：以免用不同的編輯器閱讀程序時，因TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不整齊，不要使用BC作為編輯器合版本，因為BC會自動將8個空格變?yōu)橐粋€TAB鍵，因此使用BC合入的版本大多會將縮進變亂。
1-7：函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用縮進風(fēng)格，case語句下的情況處理語句也要遵從語句縮進要求。
1-8：程序塊的分界符（如C/C++語言的大括號‘{’和‘}’）應(yīng)各獨占一行并且位于同一列，同時與引用它們的語句左對齊。在函數(shù)體的開始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及if、for、do、while、switch、case 語句中的程序都要采用如上的縮進方式。
1-9：一行程序以小于80字符為宜，不要寫得過長。
2-1：一般情況下，源程序有效注釋量必須在20％以上。
說明：注釋的原則是有助于對程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語言必須準(zhǔn)確、易懂、簡潔。
2-2：文件頭部應(yīng)進行注釋，注釋必須列出：版權(quán)說明、版本號、生成日期、作者、內(nèi)容、功能、修改日志等。
示例：下面這段頭文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。
2-3：函數(shù)頭部應(yīng)進行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關(guān)系（函數(shù)、表）等。
示例：下面這段函數(shù)的注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在內(nèi)。
2-4：邊寫代碼邊注釋，修改代碼同時修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要刪除。
2-5：注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。
說明：錯誤的注釋不但無益反而有害。
2-6：注釋應(yīng)與其描述的代碼相近，對代碼的注釋應(yīng)放在其上方或右方（對單條語句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。
2-7：對于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時都必須加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。
2-8：數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每個域的注釋放在此域的右方。
2-9：全局變量要有較詳細的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時注意事項等的說明。
2-10：注釋與所描述內(nèi)容進行同樣的縮排。
說明：可使程序排版整齊，并方便注釋的閱讀與理解。
2-11：避免在一行代碼或表達式的中間插入注釋。
說明：除非必要，不應(yīng)在代碼或表達中間插入注釋，否則容易使代碼可理解性變差。
2-12：通過對函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的。
說明：清晰準(zhǔn)確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。
2-13：在代碼的功能、意圖層次上進行注釋，提供有用、額外的信息。
說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復(fù)注釋信息。
重慶分公司
重慶分公司
