JAVA編程語言編碼規(guī)范.doc

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

1、JAVA編程語言的代碼慣例1、介紹1．1為什么要有代碼慣例代碼慣例之所以重要有以下幾點原因：軟件壽命價值的80%是維護(hù)。幾乎沒有軟件在整個使用過程中都有由原作者維護(hù)。代碼慣例增加了軟件包的可讀性，使工程師們能更快、更完整地理解新軟件。如果你想把你的原始代碼變成產(chǎn)品，你需要確認(rèn)它是否和你生產(chǎn)的其它產(chǎn)品一樣有好的包裝。1．2確認(rèn)這個文件在SUN公司的JAVA語言說明書中反映了JAVA語言編碼標(biāo)準(zhǔn)。這方面規(guī)定主要來自PeterKing,PatrickNaughton,JonniKanerva,andScottHommel.關(guān)于這個文檔的改寫、修改或再分配的問題，請看版權(quán)公告。對于這個文檔的建議請發(fā)貼

2、自alans@eng.sun.com2------文件名這一節(jié)列舉了常用的文件后綴與名稱。2．1文件后綴JAVA使用以下后綴：文件種類后綴JAVAsource.javaJAVAbytecode.class2．2普通文檔名稱通常用的文檔名稱文檔名稱使用GNUmakefilemakefile最恰當(dāng)?shù)拿?。我們使用gnumake制造我們的軟件。Readme概括特定目錄內(nèi)容的文檔的最恰當(dāng)名稱。3.文件的組織結(jié)構(gòu)一個文件應(yīng)當(dāng)由多個被分隔的段組成，并由空行和可選擇注釋來識別。超過2000行的文件由于冗長而應(yīng)當(dāng)避免。Java程序的正確格式可參看第19頁的范例“Java源文件范例”。3．1Java源文件每一個

3、Java源文件包含一個單一的公共類或界面。當(dāng)私有類或界面與一個公共類發(fā)生聯(lián)系時，你可以將它們以一個公共類放入同一個源文件。公共類應(yīng)當(dāng)是文件中的第一類或界面。Java源文件有如下次序：·起始注釋（參看第4頁“起始注釋”）·組件和導(dǎo)入語句·類和界面聲明（參看第4頁“類和界面聲明”）3．1．1起始注釋所有源文件應(yīng)當(dāng)以C格式注釋開始，并列出類名，版本信息，時間和版權(quán)說明：/**類名**版本信息**時間**版權(quán)說明*/3．1．2組件和導(dǎo)入語句對于大部分Java源文件而言，第一個無注釋行是組件語句。之后，緊跟著是導(dǎo)入語句。舉例如下：組件java.awt;導(dǎo)入java.awt.peer.CanvasPeer

4、注釋：對于唯一的組件名，第一部分總是小寫的ASCII碼格式的文本文件，并且是最高級別的域名之一。目前可用com,edu,gov,mil,net或ISO3166標(biāo)準(zhǔn)（1981）中規(guī)定的用于識別國家的英文兩個字母的模式。3．1．3類和界面聲明下表按出現(xiàn)的先后順序描述了一個類或界面說明的各部分。參見第19頁“java源文件范例”中一個包含注釋的示例。類/界面聲明的各部分注釋1類/界面文檔注釋(/**…*/)參看第9頁“文擋注釋”中注釋的具體內(nèi)容2類或界面語句3類/界面補充注釋（/*…*/），如果必要的話這一注釋應(yīng)包含任一類寬或界面寬度的信息，它不適合于類/界面文檔注釋。4類（靜態(tài)的）變量首先是公共類

5、變量，其次是保護(hù)類，然后是組件級（無訪問修改權(quán)），最后是私有類。5實例變量首先是公共類，其次是保護(hù)類，然后是組建級（無訪問修改權(quán)），最后是私有類。6構(gòu)成7過程這些過程應(yīng)當(dāng)以功能而非作用域和可訪問性來分組。舉例說明，一個私有類變量過程可在兩個公共實例過程中。其目的是使讀和理解代碼更為容易。4、縮進(jìn)格式四個空格作為一個縮進(jìn)單位。確切的縮進(jìn)格式結(jié)構(gòu)（空格符與制表符）未被規(guī)范。表格的設(shè)置必須在每8個空格后（而非4個）。4．1行的長度由于難于被大多數(shù)終端和工具進(jìn)行處理，應(yīng)當(dāng)避免一行超過80個字符。注釋：在文檔中所列舉的范例其行的長度應(yīng)稍短些，一般不超過70個字符。4．2繞回行當(dāng)表達(dá)式一行無法寫完時，使用

6、以下一般規(guī)則進(jìn)行中斷：·在逗號后中斷?！ぴ谝粋€運算符前中斷?！?yōu)先選擇高級中斷指令。·新行起始表達(dá)式的位置應(yīng)與舊行表達(dá)式的位置對齊?！と绻鲜鲆?guī)則導(dǎo)致代碼混亂或編碼時頂?shù)搅擞疫吔?，?個空格代替。以下是幾個中斷程序的調(diào)用范例：someMethod(longExpression1,longExpression2,longExpression3,longExpression4,longExpression5);var=someMethod1(longExpression1,someMethod2(longExpression2,longExpression3);以下是兩個關(guān)于中斷算術(shù)表達(dá)式的例子。

7、第一個例子由于中斷發(fā)生在插入表達(dá)式以外，因而選擇了高級中斷指令。longName1=longName2*(longName3+longName4–longName5)+4*longname6;//PREFERlongName1=longName2*(longName3+longName4longName5)+4*longname6;//AVOID以下是兩個關(guān)于縮進(jìn)程序的說明。第一個例子是常規(guī)情況。