tencent java 編碼規(guī)范

《tencent java 編碼規(guī)范》由會員上傳分享，免費在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫。

1、GL/YF013-2007V1.0-L1騰訊集團(tuán)管理標(biāo)準(zhǔn)GL/YF013-2007V1.0-L1Java編碼規(guī)范2007-09-11發(fā)布2007-09-11實施———————————————————————————————————騰訊集團(tuán)發(fā)布14GL/YF013-2007V1.0-L1前言本標(biāo)準(zhǔn)系公司首次發(fā)布實施，主要針對公司所有軟件產(chǎn)品源代碼范圍的Java編碼風(fēng)格，對Java文件的文件組織、代碼風(fēng)格、注釋、命名、聲明、異常、習(xí)慣等方面均作出規(guī)范，以保障公司項目代碼的易維護(hù)性和編碼安全性。本標(biāo)準(zhǔn)由研發(fā)管理部、3G產(chǎn)品中心共同制定。本標(biāo)準(zhǔn)主要起草人：Junjun(張莉珺)、Iron（邱會發(fā)）本標(biāo)

2、準(zhǔn)主要審核人：anwenfeng(馮文信)、Paulinesong(宋虹漫)、Ericlin（林松）、Stevezheng(鄭全戰(zhàn))、Junehuang(黃俊)、Kevinxu(許冠嚴(yán))、polo(陳廣域)、leon（郭凱天）本標(biāo)準(zhǔn)批準(zhǔn)人：jeffxiong(熊明華)、charles(陳一丹)、tony（張志東）、ponyma（馬化騰）本標(biāo)準(zhǔn)首次發(fā)布日期：2007年9月11日本標(biāo)準(zhǔn)發(fā)送部門：公司各部門14GL/YF013-2007V1.0-L1JAVA編碼規(guī)范1目的為形成公司統(tǒng)一的Java編碼風(fēng)格，以保障公司項目代碼的易維護(hù)性和編碼安全性，特制定本規(guī)范。2適用范圍本標(biāo)準(zhǔn)適用于騰訊集團(tuán)（含分公司

3、等各級分支機構(gòu)）所有使用Java作為開發(fā)語言的軟件產(chǎn)品。本標(biāo)準(zhǔn)中“騰訊集團(tuán)”是指騰訊控股有限公司、其附屬公司、及為會計而綜合入賬的公司，包括但不限于騰訊控股有限公司、深圳市騰訊計算機系統(tǒng)有限公司、騰訊科技（深圳）有限公司、騰訊科技（北京）有限公司、深圳市世紀(jì)凱旋科技有限公司、時代朝陽科技（深圳）有限公司、騰訊數(shù)碼（深圳）有限公司、深圳市財付通科技有限公司。3總體原則所有使用Java作為開發(fā)語言的軟件產(chǎn)品都須遵照本規(guī)范的內(nèi)容進(jìn)行編碼。4文件組織4.1規(guī)則4.1.1由于超過2000行的程序難以閱讀，應(yīng)該盡量避免出現(xiàn)超過2000行的程序；4.1.2一個Java源文件都包含一個單一的公共類或接口。若私

4、有類和接口與一個公共類相關(guān)聯(lián)，可以將它們和公共類放入同一個源文件。公共類必須是這個文件中的第一個類或接口。4.2組織順序14GL/YF013-2007V1.0-L14.2.1文件注釋（參見"6.1文件注釋"）；4.2.2包和引入語句：在多數(shù)Java源文件中，第一個非注釋行是包語句。在它之后可以跟引入語句；4.2.3類或接口注釋（參見"6.2類或接口注釋"）；4.2.4類或接口的聲明；4.2.5類或接口的實現(xiàn)注釋：如果有關(guān)類或接口的信息不適合作為“類或接口文檔注釋”，可以在類或接口的實現(xiàn)注釋中給出；4.2.6類的（靜態(tài)）變量：首先是類的公共變量，隨后是保護(hù)變量，再后是包一級別的變量（沒有訪問修飾

5、符），最后是私有變量；4.2.7實例變量：首先是公共級別的，隨后是保護(hù)級別的，再后是包一級別的（沒有訪問修飾符），最后是私有級別的；4.2.8構(gòu)造方法；4.2.9方法：方法應(yīng)該按功能分組，而不應(yīng)該按作用域或訪問權(quán)限進(jìn)行分組。4.3范例直接查看以下文件可以找到編碼套用的規(guī)則：（注：可以通過復(fù)制粘貼保存到硬盤）5代碼風(fēng)格5.1縮進(jìn)5.1.1程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)只使用TAB鍵，不能使用空格鍵（編輯器中請將TAB設(shè)置為4格）；5.1.2方法體的開始、類的定義、以及if、for、do、while、switch、case語句中的代碼都要采用縮進(jìn)方式；5.2對齊5.2.1程序塊的分界符左大括號"{

6、"和右大括號"}"都另起一行，應(yīng)各獨占一行并且位于同一列，同時與引用它們的語句左對齊；14GL/YF013-2007V1.0-L15.2.2對齊只使用TAB鍵，不使用空格鍵；5.2.3不允許把多個短語句寫在一行中，即一行只寫一條語句；5.2.4if、for、do、while、case、switch、default等語句自占一行。5.3換行一行的長度超過80個字符需要換行，換行規(guī)則如下：5.3.1在一個逗號后面斷開；5.3.2在一個操作符前面斷開；5.3.3長表達(dá)式要在低優(yōu)先級操作符處劃分新行；5.3.4新行縮進(jìn)2個TAB。5.4間隔5.4.1類、方法及相對獨立的程序塊之間、變量說明之后必須加空

7、行；5.4.2關(guān)鍵字之后要留空格，象if、for、while等關(guān)鍵字之后應(yīng)留一個空格再跟左括號"（"，以突出關(guān)鍵字；5.4.3方法名與其左括號"（"之間不要留空格,以與關(guān)鍵字區(qū)別；5.4.4二元操作符如"="、"+="">="、"<="、"+"、"*"、"%"、"&&"、"

8、

9、"、"<<","^"等的前后應(yīng)當(dāng)加空格；5.4.5一元操作符如"!"、"~"、"++"、"--"等前后不加空格；5.4.6