Java的語言編碼規(guī)范.doc

《Java的語言編碼規(guī)范.doc》由會員上傳分享，免費在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫。

1、Java語言編碼規(guī)范目錄1介紹41.1為什么要有編碼規(guī)范41.2目的41.3適用范圍42文件名52.1文件后綴52.2常用文件名53文件組織63.1Java源文件63.1.1開頭注釋63.1.2包和引入語句73.1.3類和接口聲明74縮進排版84.1行長度94.2換行95注釋125.1實現(xiàn)注釋的格式135.1.1塊注釋145.1.2單行注釋155.1.3尾端注釋155.1.4行末注釋165.2文檔注釋176聲明186.1每行聲明變量的數(shù)量186.2初始化196.3布局196.4類和接口的聲明217語句227.1簡單語句227.2復(fù)合語句227.3返回語句23

2、7.4if，if-else，ifelse-ifelse語句237.5for語句247.6while語句257.7do-while語句267.8switch語句267.9try-catch語句278空白288.1空行288.2空格299命名規(guī)范3010編程慣例3210.1提供對實例以及類變量的訪問控制3210.2引用類變量和類方法3310.3常量3310.4變量賦值3310.5其它慣例3510.5.1圓括號3510.5.2返回值3510.5.3條件運算符"?"前的表達式3610.5.4特殊注釋3611代碼范例3711.1Java源文件范例371介紹1.1為什么

3、要有編碼規(guī)范編碼規(guī)范對于程序員而言尤為重要，有以下幾個原因：-一個軟件的生命周期中，80%的花費在于維護-幾乎沒有任何一個軟件，在其整個生命周期中，均由最初的開發(fā)人員來維護-編碼規(guī)范可以改善軟件的可讀性，可以讓程序員盡快而徹底地理解新的代碼-如果你將源碼作為產(chǎn)品發(fā)布，就需要確任它是否被很好的打包并且清晰無誤，一如你已構(gòu)建的其它任何產(chǎn)品為了執(zhí)行規(guī)范，每個軟件開發(fā)人員必須一致遵守編碼規(guī)范，每個人。1.2目的本規(guī)范的主要目的是描述E.E團隊研發(fā)項目的編程約定，規(guī)范軟件工程師的編碼風(fēng)格，使E.E團隊的軟件產(chǎn)品具有統(tǒng)一的風(fēng)格，使得軟件具有較高的可維護性和可復(fù)用性。1.

4、3適用范圍本文檔適用E.E團隊的研發(fā)項目。2文件名這部分列出了常用的文件名及其后綴。2.1文件后綴Java程序使用下列文件后綴：文件類別文件后綴Java源文件.javaJava字節(jié)碼文件.class2.2常用文件名常用的文件名包括：文件名用途GNUmakefilemakefiles的首選文件名。我們采用gnumake來創(chuàng)建（build）軟件。README概述特定目錄下所含內(nèi)容的文件的首選文件名3文件組織一個文件由被空行分割而成的段落以及標識每個段落的可選注釋共同組成。超過2000行的程序難以閱讀，應(yīng)該盡量避免。"Java源文件范例"提供了一個布局合理的Jav

5、a程序范例。3.1Java源文件每個Java源文件都包含一個單一的公共類或接口。若私有類和接口與一個公共類相關(guān)聯(lián)，可以將它們和公共類放入同一個源文件。公共類必須是這個文件中的第一個類或接口。Java源文件還遵循以下規(guī)則：-開頭注釋-包和引入語句-類和接口聲明3.1.1開頭注釋所有的源文件都應(yīng)該在開頭有一個C語言風(fēng)格的注釋，其中列出類名、版本信息、日期和版權(quán)聲明：/**Classname**Versioninformation**Date**Copyrightnotice*/3.1.2包和引入語句在多數(shù)Java源文件中，第一個非注釋行是包語句。在它之后可以跟引

6、入語句。例如：packagejava.awt;importjava.awt.peer.CanvasPeer;3.1.3類和接口聲明下表描述了類和接口聲明的各個部分以及它們出現(xiàn)的先后次序。?類/接口聲明的各部分注解1類/接口文檔注釋(/**……*/)該注釋中所需包含的信息2類或接口的聲明?3類/接口實現(xiàn)的注釋(/*……*/)如果有必要的話該注釋應(yīng)包含任何有關(guān)整個類或接口的信息，而這些信息又不適合作為類/接口文檔注釋。4類的(靜態(tài))變量首先是類的公共變量，隨后是保護變量，再后是包一級別的變量(沒有訪問修飾符，accessmodifier)，最后是私有變量。5實例

7、變量首先是公共級別的，隨后是保護級別的，再后是包一級別的(沒有訪問修飾符)，最后是私有級別的。6構(gòu)造器?7方法這些方法應(yīng)該按功能，而非作用域或訪問權(quán)限，分組。例如，一個私有的類方法可以置于兩個公有的實例方法之間。其目的是為了更便于閱讀和理解代碼。4縮進排版4個空格常被作為縮進排版的一個單位?？s進的確切解釋并未詳細指定(空格vs.制表符)。一個制表符等于8個空格(而非4個)。4.1行長度盡量避免一行的長度超過80個字符，因為很多終端和工具不能很好處理之。注意：用于文檔中的例子應(yīng)該使用更短的行長，長度一般不超過70個字符。4.2換行當(dāng)一個表達式無法容納在一行內(nèi)時

8、，可以依據(jù)如下一般規(guī)則斷開之：-在一個逗號后面斷開-