華為程式編寫規範

1 排版
1.1：程式塊要採用縮排風格編寫，縮排的空格數為4個。對於由開發工具自動生成的程式碼可以有不一致。
1.2：相對獨立的程式塊之間、變數說明之後必須加空行。
1.3：較長的語句（>80字元）要分成多行書寫，長表示式要在低優先順序操作符處劃分新行，操作符放在新行之首，劃分出的新行要進行適當的縮排，使排版整齊，語句可讀。
1.4：迴圈、判斷等語句中若有較長的表示式或語句，則要進行適應的劃分，長表示式要在低優先順序操作符處劃分新行，操作符放在新行之首。
1.5：若函式或過程中的引數較長，則要進行適當的劃分。
1.6：不允許把多個短語句寫在一行中，即一行只寫一條語句。
1.7：if、for、do、while、case、switch、default等語句自佔一行，且if、for、do、while等語句的執行語句部分無論多少都要加括號{}。
1.8：對齊只用空格鍵，不使用TAB鍵。
說明：以免用不同的編輯器閱讀程式時，因TAB鍵所設定的空格數目不同而造成程式佈局不整齊，不要使用BC作為編輯器合版本，因為BC會自動將8個空格變為一個TAB鍵，因此使用BC合入的版本大多會將縮排變亂。
1.9：函式或過程的開始、結構的定義及迴圈、判斷等語句中的程式碼都要採用縮排風格，case語句下的情況處理語句也要遵從語句縮排要求。
1.10：程式塊的分界符（如C/C++語言的大括號‘{’和‘}’）應各獨佔一行並且位於同一列，同時與引用它們的語句左對齊。在函式體的開始、類的定義、結構的定義、列舉的定義以及if、for、do、while、switch、case語句中的程式都要採用如上的縮排方式。
1.11：在兩個以上的關鍵字、變數、常量進行對等操作時，它們之間的操作符之前、之後或者前後要加空格；進行非對等操作時，如果是關係密切的立即操作符（如－>），後不應加空格。
說明：採用這種鬆散方式編寫程式碼的目的是使程式碼更加清晰。由於留空格所產生的清晰性是相對的，所以，在已經非常清晰的語句中沒有必要再留空格，如果語句已足夠清晰則括號內側(即左括號後面和右括號前面)不需要加空格，多重括號間不必加空格，因為在C/C++語言中括號已經是最清晰的標誌了。在長語句中，如果需要加的空格非常多，那麼應該保持整體清晰，而在區域性不加空格。給操作符留空格時不要連續留兩個以上空格。
2 註釋

2.1：一般情況下，源程式有效註釋量必須在20％以上。
說明：註釋的原則是有助於對程式的閱讀理解，在該加的地方都加了，註釋不宜太多也不能太少，註釋語言必須準確、易懂、簡潔。
2.2：說明性檔案（如標頭檔案.h檔案、.inc檔案、.def檔案、編譯說明檔案.cfg等）頭部應進行註釋，註釋必須列出：版權說明、版本號、生成日期、作者、內容、功能、與其它檔案的關係、修改日誌等，標頭檔案的註釋中還應有函式功能簡要說明。
2.3：原始檔頭部應進行註釋，列出：版權說明、版本號、生成日期、作者、模組目的/功能、主要函式及其功能、修改日誌等。
說明：Description一項描述本檔案的內容、功能、內部各部分之間的關係及本檔案與其它檔案關係等。History是修改歷史記錄列表，每條修改記錄應包括修改日期、修改者及修改內容簡述。
2.4：函式頭部應進行註釋，列出：函式的目的/功能、輸入引數、輸出引數、返回值、呼叫關係（函式、表）等。
2.5：邊寫程式碼邊註釋，修改程式碼同時修改相應的註釋，以保證註釋與程式碼的一致性。不再有用的註釋要刪除。
2.6：註釋的內容要清楚、明瞭，含義準確，防止註釋二義性。
說明：錯誤的註釋不但無益反而有害。
2.7：避免在註釋中使用縮寫，特別是非常用縮寫。
說明：在使用縮寫時或之前，應對縮寫進行必要的說明。
2.8：註釋應與其描述的程式碼相近，對程式碼的註釋應放在其上方或右方（對單條語句的註釋）相鄰位置，不可放在下面，如放於上方則需與其上面的程式碼用空行隔開。
2.9：對於所有有物理含義的變數、常量，如果其命名不是充分自注釋的，在宣告時都必須加以註釋，說明其物理含義。變數、常量、巨集的註釋應放在其上方相鄰位置或右方。
2.10：資料結構宣告(包括陣列、結構、類、列舉等)，如果其命名不是充分自注釋的，必須加以註釋。對資料結構的註釋應放在其上方相鄰位置，不可放在下面；對結構中的每個域的註釋放在此域的右方。
2.11：全域性變數要有較詳細的註釋，包括對其功能、取值範圍、哪些函式或過程存取它以及存取時注意事項等的說明。
2.12：註釋與所描述內容進行同樣的縮排。
說明：可使程式排版整齊，並方便註釋的閱讀與理解。
2.13：將註釋與其上面的程式碼用空行隔開。
2.14：對變數的定義和分支語句（條件分支、迴圈語句等）必須編寫註釋。
說明：這些語句往往是程式實現某一特定功能的關鍵，對於維護人員來說，良好的註釋幫助更好的理解程式，有時甚至優於看設計文件。
2.15：對於switch語句下的case語句，如果因為特殊情況需要處理完一個c ase後進入下一個case處理，必須在該case語句處理完、下一個case語句前 加上明確的註釋。
說明：這樣比較清楚程式編寫者的意圖，有效防止無故遺漏break語句。
3 識別符號命名
3.1：識別符號的命名要清晰、明瞭，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產生誤解。
說明：較短的單詞可通過去掉“母音”形成縮寫；較長的單詞可取單詞的頭幾個字母形成縮寫；一些單詞有大家公認的縮寫。
3.2：命名中若使用特殊約定或縮寫，則要有註釋說明。
說明：應該在原始檔的開始之處，對檔案中所使用的縮寫或約定，特別是特殊的縮寫，進行必要的註釋說明。
3.3：自己特有的命名風格，要自始至終保持一致，不可來回變化。
說明：個人的命名風格，在符合所在專案組或產品組的命名規則的前提下，才可使用。（即命名規則中沒有規定到的地方才可有個人命名風格）。
3.4：對於變數命名，禁止取單個字元（如i、j、k…），建議除了要有具體含義外，還能表明其變數型別、資料型別等，但i、j、k作區域性迴圈變數是允許的。
說明：變數，尤其是區域性變數，如果用單個字元表示，很容易敲錯（如i寫成j），而編譯時又檢查不出來，有可能為了這個小小的錯誤而花費大量的查錯時間。
3.5：命名規範必須與所使用的系統風格保持一致，並在同一專案中統一，比如採用UNIX的全小寫加下劃線的風格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式，用作特殊標識如標識成員變數或全域性變數的m_和g_，其後加上大小寫混排的方式是允許的。
4 可讀性
4.1：注意運算子的優先順序，並用括號明確表示式的操作順序，避免使用預設優先順序。
說明：防止閱讀程式時產生誤解，防止因預設的優先順序與設計思想不符而導致程式出錯。
4.2：避免使用不易理解的數字，用有意義的標識來替代。涉及物理狀態或者含有物理意義的常量，不應直接使用數字，必須用有意義的列舉或巨集來代替。
5 變數、結構
5.1：去掉沒必要的公共變數。
說明：公共變數是增大模組間耦合的原因之一，故應減少沒必要的公共變數以降低模組間的耦合度。
5.2：仔細定義並明確公共變數的含義、作用、取值範圍及公共變數間的關係。
說明：在對變數宣告的同時，應對其含義、作用及取值範圍進行註釋說明，同時若有必要還應說明與其它變數的關係。
5.3：明確公共變數與操作此公共變數的函式或過程的關係，如訪問、修改及建立等。
說明：明確過程操作變數的關係後，將有利於程式的進一步優化、單元測試、系統聯調以及程式碼維護等。這種關係的說明可在註釋或文件中描述。
5.4：當向公共變數傳遞資料時，要十分小心，防止賦與不合理的值或越界等現象發生。
說明：對公共變數賦值時，若有必要應進行合法性檢查，以提高程式碼的可靠性、穩定性。
5.5：防止區域性變數與公共變數同名。
說明：若使用了較好的命名規則，那麼此問題可自動消除。
5.6：嚴禁使用未經初始化的變數作為右值。
說明：特別是在C/C++中引用未經賦值的指標，經常會引起系統崩潰。
6 函式、過程
6.1：對所呼叫函式的錯誤返回碼要仔細、全面地處理。
6.2：明確函式功能，精確（而不是近似）地實現函式設計。
6.3：編寫可重入函式時，應注意區域性變數的使用（如編寫C/C++語言的可重入函式時，應使用auto即預設態區域性變數或暫存器變數）。
說明：編寫C/C++語言的可重入函式時，不應使用static區域性變數，否則必須經過特殊處理，才能使函式具有可重入性。
6.4：編寫可重入函式時，若使用全域性變數，則應通過關中斷、訊號量（即P、V操作）等手段對其加以保護。
說明：若對所使用的全域性變數不加以保護，則此函式就不具有可重入性，即當多個程序呼叫此函式時，很有可能使有關全域性變數變為不可知狀態。
6.5：在同一專案組應明確規定對介面函式引數的合法性檢查應由函式的呼叫者負責還是由介面函式本身負責，預設是由函式呼叫者負責。
說明：對於模組間介面函式的引數的合法性檢查這一問題，往往有兩個極端現象，即：要麼是呼叫者和被呼叫者對引數均不作合法性檢查，結果就遺漏了合法性檢查這一必要的處理過程，造成問題隱患；要麼就是呼叫者和被呼叫者均對引數進行合法性檢查，這種情況雖不會造成問題，但產生了冗餘程式碼，降低了效率。
6.1：防止將函式的引數作為工作變數。
說明：將函式的引數作為工作變數，有可能錯誤地改變引數內容，所以很危險。對必須改變的引數，最好先用區域性變數代之，最後再將該區域性變數的內容賦給該引數。

騰訊程式編寫規範

一、java檔案組織
檔案組織規則：由於超過2000行的程式難以閱讀，應該儘量避免出現超過2000行的程式。一個Java原始檔都包含一個單一的公共類或介面。若私有類和介面與一個公共類相關聯，可以將它們和公共類放入同一個原始檔。公共類必須是這個檔案中的第一個類或介面。
檔案組織順序：
1.檔案註釋：所有的原始檔都應該在開頭有一個註釋，其中列出檔案的版權宣告、檔名、功能描述以及建立、修改記錄：
2.包和引入語句：在多數Java原始檔中，第一個非註釋行是包語句。在它之後可以跟導包語句
3. 類或介面註釋：採用JavaDoc文件註釋，在類、介面定義之前應當對其進行註釋，包括類、介面的描述、最新修改者、版本號、參考連結等；
注：JavaDoc文件註釋：描述Java的類、介面、構造方法、方法、以及欄位。每個文件註釋都會被置於註釋定界符/…*/之中，一個註釋對應一個類、介面或成員。該註釋應位於宣告之前。文件註釋的第一行(/**)不需縮排，隨後的文件註釋每行都縮排1格(使星號縱向對齊)。
4. 類或介面的宣告**
5. 類或介面的實現註釋：如果有關類或介面的資訊不適合作為“類或介面文件註釋”，可以在類或介面的實現註釋中給出；
6. 類的（靜態）變數：首先是類的公共變數，隨後是保護變數，再後是包一級別的變數（沒有訪問修飾符），最後是私有變數；
7. 例項變數：首先是公共級別的，隨後是保護級別的，再後是包一級別的（沒有訪問修飾符），最後是私有級別的；
8. 構造方法；
9. 普通方法：方法應該按功能分組，而不應該按作用域或訪問許可權進行分組。
二、程式碼風格
1.縮排：程式塊要採用縮排風格編寫，縮排只使用TAB鍵，不能使用空格鍵（編輯器中請將TAB設定為4格）；方法體的開始、類的定義、以及if、for、do、while、switch、case語句中的程式碼都要採用縮排方式；
2.對齊：程式塊的分界符左大括號”{” 和右大括號”}”都另起一行，應各獨佔一行並且位於同一列，同時與引用它們的語句左對齊；對齊只使用TAB鍵，不使用空格鍵；不允許把多個短語句寫在一行中，即一行只寫一條語句；if、for、do、while、case、switch、default等語句自佔一行。
3.換行：一行的長度超過80個字元需要換行，換行規則如下：
在一個逗號後面斷開；
在一個操作符前面斷開；
長表示式要在低優先順序操作符處劃分新行；
新行縮排2個TAB。
4.間隔：類、方法及相對獨立的程式塊之間、變數說明之後必須加空行；關鍵字之後要留空格， 象if、for、while 等關鍵字之後應留一個空格再跟左括號”（”， 以突出關鍵字；方法名與其左括號”（”之間不要留空格, 以與關鍵字區別；二元操作符如 ” =”、” +=” ” >=”、” <=”、” +”、” *”、” %”、” &&”、” ||”、” <<” ,” ^” 等的前後應當加空格；一元操作符如” !”、” ~”、” ++”、” –”等前後不加空格；xiang”［ ］”、” .” 這類操作符前後不加空格；for語句中的表示式應該被空格分開；強制轉型後應該跟一個空格。
三、註釋
1.原則：對已經不推薦使用的類和方法需要註明@Deprecated，並說明替代的類或者方法；對於針對集合、開關的方法，要在方法註釋中表明是否多執行緒安全。
2．欄位註釋: 採用JavaDoc文件註釋，定義為public的欄位必需給出註釋，在類的(靜態)變數、例項變數定義之前當對其進行註釋，給出該欄位的描述等：
3.方法註釋：採用JavaDoc文件註釋，在方法定義之前當對其進行註釋，包括方法的描述、輸入、輸出及返回值說明、丟擲異常說明、參考連結等：
4.單行註釋格式//
5.多行註釋格式/……/
四、命名規則
1.基本規則:使用可以準確說明變數、欄位、類、介面、包等完整的英文描述符；採用大小寫混合，提高名字的可讀性；採用該領域的術語；儘量少用縮寫，但如果一定要使用，當使用公共縮寫和習慣縮寫等；避免使用相似或者僅在大小寫上有區別的名字。
2.包命名：包名一律小寫, 少用縮寫和長名；採用以下規則：
[基本包].[專案名].[模組名].[子模組名]…
不得將類直接定義在基本包下，所有專案中的類、介面等都應當定義在各自的專案和模組包中。
3.類或介面命名：類或介面名是個一名詞，採用大小寫混合的方式，每個單詞的首字母大寫。儘量使你的類名簡潔而富於描述。使用完整單詞，避免用縮寫詞(除非該縮寫詞被更廣泛使用，像URL，HTML)。
4.變數命名: 採用大小寫混合的方式，第一個單詞的首字母小寫，其後單詞的首字母大寫；變數名不應以下劃線或美元符號開頭；儘量避免單個字元的變數名，除非是一次性的臨時變數。臨時變數通常被取名為i，j，k，m和n，它們一般用於整型；c，d，e，它們一般用於字元型；不採用匈牙利命名法則，對不易清楚識別出該變數型別的變數應使用型別名或型別名縮寫作其後綴；元件或部件變數使用其型別名或型別名縮寫作其後綴；集合型別變數，例如陣列和向量，應採用複數命名或使用表示該集合的名詞做字尾。
5.常量命名：全部採用大寫，單詞間用下劃線隔開。
6．方法命名：方法名是一個動詞，採用大小寫混合的方式，第一個單詞的首字母小寫，其後單詞的首字母大寫；取值類可使用get字首，設值類可使用set字首，判斷類可使用is(has)字首。
五、宣告
1.類或介面的聲名：類、介面定義語法規範如下
[可見性][(‘abstract’|’final’)] [Class|Interface] class_name
[(‘extends’|’implements’)][父類或介面名]{
//方法體
}
2.方法宣告：良好的程式設計應該儘可能減小類與類之間耦合，所遵循的經驗法則是：儘量限制成員函式的可見性。如果成員函式沒必要公有 (public)，就定義為保護 (protected)；沒必要保護 (protected)，就定義為私有 (private)；方法定義語法規範：
[可見性][‘abstract’] [‘static’] [‘final’] [‘synchronized’][返回值型別] method_name(引數列表)[(‘throws’)][異常列表]{
//方法體
}
宣告順序：構造方法、靜態公共方法、靜態私有方法、公共方法、友元方法、受保護方法、私有方法、main方法；方法引數建議順序：(被操作者，操作內容，操作標誌，其他)。
3.變數宣告：一行一個宣告；宣告區域性變數的同時初始化（在變數的初始值依賴於某些先前發生的計算的特殊情況下可以不用同時初始化）；只在程式碼塊的開始處宣告變數，（一個塊是指任何被包含在大括號”{“和”}”中間的程式碼）不要在首次用到該變數時才宣告；避免宣告的區域性變數覆蓋上一級宣告的變數，即不要在內部程式碼塊中宣告相同的變數名；公共和保護的可見性應當儘量避免，所有的欄位都建議置為私有，由獲取和設定成員函式（Getter、Setter）訪問；定義一個變數或者常量的時候，不要包含包名（類似java.security.MessageDigest digest = null），除非是兩個包有相同的類名；陣列宣告時應當將”[]”跟在型別後，而不是欄位名後；宣告順序：常量、類變數、例項變數、公有欄位、受保護欄位、友元欄位、私有欄位。
六、異常
1.捕捉異常的目的是為了處理它
2. 多個異常應分別捕捉並處理，避免使用一個單一的catch來處理。
七、習慣
1. if、for、do、while等語句的執行語句部分無論多少都要加括號”{}”
2. 每當一個case順著往下執行時(因為沒有break語句)，通常應在break語句的位置添加註釋；
3. 儘量避免在迴圈中構造和釋放物件
4. 在使用區域性變數的過程，按就近原則處理。不允許定義一個區域性變數，然後在很遠的地方才使用；
5.相同的功能不允許複製成N份程式碼；
6. 在處理 String 的時候要儘量使用 StringBuffer 類。