資源描述：
《java語(yǔ)言編碼規(guī)范》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫(kù)。
1、Java編碼規(guī)范密級(jí)：內(nèi)部公開文檔編號(hào)：版本號(hào)：V1.0分冊(cè)名稱：第1冊(cè)/共1冊(cè)Java編碼規(guī)范編制：生效日期：審核：批準(zhǔn)：文件更改摘要：日期版本號(hào)修訂說明修訂人審核人批準(zhǔn)人第24頁(yè)共25頁(yè)Java編碼規(guī)范第24頁(yè)共25頁(yè)Java編碼規(guī)范目錄1.介紹41.1為什么要有編碼規(guī)范41.2注意事項(xiàng)42.文件名42.1文件后綴42.2常用文件名43.文件組織53.1Java源文件53.1.1包和引入語(yǔ)句53.1.2類和接口聲明54.縮進(jìn)排版64.1行長(zhǎng)度64.2換行64.3對(duì)于{}85.注釋85.1實(shí)現(xiàn)注釋的格式85.1.1塊注釋85.1.2單行注釋9
2、5.1.3尾端注釋95.1.4行末注釋95.2文檔注釋105.3注釋內(nèi)容105.3.1方法注釋105.3.2算法注釋115.3.3可精簡(jiǎn)的注釋內(nèi)容115.3.4推薦的注釋內(nèi)容115.3.5Null的規(guī)約115.3.6特殊代碼注釋126.聲明126.1每行聲明變量的數(shù)量126.2初始化126.3布局126.4類和接口的聲明136.5聲明規(guī)則147.語(yǔ)句147.1簡(jiǎn)單語(yǔ)句147.2復(fù)合語(yǔ)句14第24頁(yè)共25頁(yè)Java編碼規(guī)范7.3返回語(yǔ)句147.4if，if-else，ifelse-ifelse語(yǔ)句157.5for語(yǔ)句157.6while語(yǔ)句167
3、.7do-while語(yǔ)句167.8switch語(yǔ)句167.9try-catch語(yǔ)句168.空白178.1空行178.2空格179.命名規(guī)范189.1命名規(guī)則199.1.1包命名199.1.2類、接口命名199.1.3方法命名199.1.4變量命名209.1.5常量命名2010.編程慣例2010.1提供對(duì)實(shí)例以及類變量的訪問控制2010.2引用類變量和類方法2010.3常量2010.4變量賦值2110.5異常處理2110.6其它慣例2110.6.1圓括號(hào)2110.6.2返回值2110.6.3條件運(yùn)算符“?”前的表達(dá)式*2211.信息輸出2212.
4、代碼范例2212.1Java源文件范例22第24頁(yè)共25頁(yè)Java編碼規(guī)范1.介紹1.1為什么要有編碼規(guī)范編碼規(guī)范對(duì)于程序員而言尤為重要，有以下幾個(gè)原因：l一個(gè)軟件的生命周期中，80%的花費(fèi)在于維護(hù)；l幾乎沒有任何一個(gè)軟件，在其整個(gè)生命周期中，均由最初的開發(fā)人員來維護(hù)；l編碼規(guī)范可以改善軟件的可讀性，可以讓程序員盡快而徹底地理解新的代碼；l如果你將源碼作為產(chǎn)品發(fā)布，就需要確任它是否被很好的打包并且清晰無(wú)誤，一如你已構(gòu)建的其它任何產(chǎn)品。制定本規(guī)范的目的是為了讓代碼清晰整潔、增強(qiáng)可讀性。所有編碼必須圍繞此原則，即使是本規(guī)范中未特別指明1.2注意事項(xiàng)
5、l本文檔未特別標(biāo)注的都必須遵守(不遵守將代表代碼不合格，會(huì)給團(tuán)隊(duì)其他成員帶來不便和困擾，大大提高總體維護(hù)成本)2.文件名這部分列出了常用的文件名及其后綴。2.1文件后綴Java程序使用下列文件后綴：文件類別文件后綴Java源文件.javaJava字節(jié)碼文件.classJSP文件.jspXML文件.xml資源文件.properties日志文件.logTaglib文件.tldJava包文件.jar層疊樣式表文件.css2.2常用文件名常用的文件名包括：第24頁(yè)共25頁(yè)Java編碼規(guī)范文件名用途Build.xmlAnt編譯配置Web.xmlJavaW
6、eb程序的配置文件Server.xmlTomcat的配置文件log4j.propertiesLog4j配置文件hibernate.cfg.xmlHibernate配置文件ApplicationResources.properties程序的英文資源文件ApplicationResources_zh_CN.properties程序的gbk資源文件struts-config-**.xmlStruts配置文件applicationContext-***.xmlSpring配置文件3.文件組織一個(gè)文件由被空行分割而成的段落以及標(biāo)識(shí)每個(gè)段落的可選注釋共同組
7、成。超過2000行的程序難以閱讀，應(yīng)該盡量避免?！癑ava源文件范例”提供了一個(gè)布局合理的Java程序范例。3.1Java源文件每個(gè)Java源文件都包含一個(gè)單一的公共類或接口。若私有類和接口與一個(gè)公共類相關(guān)聯(lián)，可以將它們和公共類放入同一個(gè)源文件。公共類必須是這個(gè)文件中的第一個(gè)類或接口。Java源文件還遵循以下規(guī)則：?包和引入語(yǔ)句?類和接口聲明3.1.1包和引入語(yǔ)句在Java源文件中，第一個(gè)非注釋行是包語(yǔ)句。在它之后可以跟引入語(yǔ)句。例如：packagejava.awt;importjava.awt.peer.CanvasPeer;import順序
8、：系統(tǒng)，第三方，自定義3.1.2類和接口聲明下表描述了類和接口聲明的各個(gè)部分以及它們出現(xiàn)的先后次序。參見代碼范例類/接口聲明的各部分注釋1類/接口文檔
