Google的Java編碼規(guī)范
Google最近發(fā)布了一份完整的Java編碼規(guī)范。規(guī)范的內(nèi)容包括一些切實(shí)可行的硬性規(guī)定。Google內(nèi)部均遵守此規(guī)范。該規(guī)范不僅涵蓋了代碼格式,還包括其他類型的約定和編碼標(biāo)準(zhǔn)。
該規(guī)范主要分為6大部分:源文件基本規(guī)范、源文件結(jié)構(gòu)、代碼格式、命名、編程實(shí)踐和Javadoc。源文件基本規(guī)范說(shuō)明文件名、文件編碼、空格和特殊字符等規(guī)范要求。源文件結(jié)構(gòu)說(shuō)明許可信息、package和import聲明、類成員順序等規(guī)范要求。代碼格式用于說(shuō)明源代碼中大括號(hào)、縮進(jìn)、換行、空格、括號(hào)、枚舉、數(shù)組、switch語(yǔ)句、注解、注釋和修飾符等格式要求。命名說(shuō)明了標(biāo)識(shí)符(包、類、方法、常量、屬性、局部變量和類變量)的命名規(guī)范和駝峰大小寫定義。編程實(shí)踐說(shuō)明@Override、異常、靜態(tài)成員和終結(jié)器的用法。Javadoc說(shuō)明哪些地方需要Javadoc,以及它的格式要求。
以下是從規(guī)范中摘錄的一些內(nèi)容:
import中不能有通配符。重載方法應(yīng)該放在一起連續(xù)出現(xiàn)。即使代碼塊中沒(méi)有內(nèi)容,或者只有一行代碼,也必須使用大括號(hào)。2空格縮進(jìn)。列寬是80或100個(gè)字符。不能使用類似C語(yǔ)言的數(shù)組變量聲明。switch語(yǔ)句中,必須包含default語(yǔ)句。修飾符的順序應(yīng)按照J(rèn)ava語(yǔ)言規(guī)范推薦的順序。常量命名應(yīng)使用CONSTANT_CASE格式(譯注:所有字母大寫,單詞使用下劃線分隔)。注意,所有常量都必須是static final成員,但并不是所有的static final成員都是常量。更多內(nèi)容請(qǐng)閱讀Google Java Style。Oracle也提供了官方的Java語(yǔ)言編碼規(guī)范。Google還提供了其它語(yǔ)言的代碼風(fēng)格指南,包括C++、Objective-C、Python、Shell、HTML/CSS、JavaScript和Lisp等等。
原文英文鏈接:Google's Java Coding Standards
相關(guān)文章:
1. 解決vue頁(yè)面刷新,數(shù)據(jù)丟失的問(wèn)題2. python 讀txt文件,按‘,’分割每行數(shù)據(jù)操作3. python logging.info在終端沒(méi)輸出的解決4. vue路由分文件拆分管理詳解5. vue+vuex+axios從后臺(tái)獲取數(shù)據(jù)存入vuex,組件之間共享數(shù)據(jù)操作6. 詳解android adb常見(jiàn)用法7. SpringBoot使用Captcha生成驗(yàn)證碼8. android studio實(shí)現(xiàn)簡(jiǎn)單的計(jì)算器(無(wú)bug)9. android 控件同時(shí)監(jiān)聽單擊和雙擊實(shí)例10. Python 忽略文件名編碼的方法
