java 語言編碼規(guī)范

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

1、Java語言編碼規(guī)范Java語言編碼規(guī)范第8頁Java語言編碼規(guī)范目錄一、規(guī)范簡介11目的12范圍13參考文檔14說明1二、JAVA編碼規(guī)范12縮進排版(Indentation)22.1行長度(LineLength)23注釋(Comments)24聲明(Declarations)34.1每行聲明變量的數(shù)量(NumberPerLine)34.2初始化(Initialization)35空白(WhiteSpace)35.1空行(BlankLines)35.2空格(BlankSpaces)46命名規(guī)范(NamingConventions)47性能考慮57.

2、1使用StringBuffer對象57.2可移植性57.3換行57.4PrintStream6三、JSP編碼規(guī)范6四、SERVLET編碼規(guī)范7五、JSP和SERVLET編程注意事項7六、代碼范例(CODEEXAMPLES)7第8頁Java語言編碼規(guī)范一、規(guī)范簡介1目的制訂本規(guī)范的目的是為培養(yǎng)規(guī)范設計和編程，養(yǎng)成良好的習慣，增強JAVA類軟件產品的穩(wěn)定、健壯、可靠性;同時也為提高軟件的可讀性，可以讓程序員盡快而徹底地理解新的代碼，使產品可維護性提高而制定的強制性規(guī)范，同時也是代碼復審的依據。2范圍本規(guī)范適用于公司JAVA類代碼（包括JSP）的代碼編寫標

3、準。適用于代碼編寫階段和代碼維護階段。3參考文檔《SUNJAVA代碼編寫規(guī)范》。4說明本文檔包括java編碼規(guī)范，jsp編碼規(guī)范，servlet編碼規(guī)范。struts代碼規(guī)范請參閱《struts編碼規(guī)范.doc》。二、java編碼規(guī)范1.1.1開頭注釋(BeginningComments)所有的源文件都應該在開頭有一個Java語言風格的注釋，其中列出標題、描述、日期和版權聲明：/***

Title:標題

Description:描述

Copyright:Copyright(c)2007

Company:華

4、勝天成

5、行長度(LineLength)盡量避免一行的長度超過80個字符，因為很多終端和工具不能很好處理之。注意：用于文檔中的例子應該使用更短的行長，長度一般不超過70個字符。3注釋(Comments)Java程序原有兩類注釋：實現(xiàn)注釋(implementationcomments)和文檔注釋(documentcomments)，我們自己又增加了一種注釋叫標記注釋。實現(xiàn)注釋是那些在C++中見過的，使用/*...*/和//界定的注釋。文檔注釋(被稱為"doccomments")是Java獨有的，并由/**...*/界定。文檔注釋可以通過javadoc工具轉換成H

6、TML文件。實現(xiàn)注釋用以注釋代碼或者實現(xiàn)細節(jié)。文檔注釋從實現(xiàn)自由(implementation-free)的角度描述代碼的規(guī)范。它可以被那些手頭沒有源碼的開發(fā)人員讀懂。注釋應被用來給出代碼的總括，并提供代碼自身沒有提供的附加信息。注釋應該僅包含與閱讀和理解程序有關的信息。例如，相應的包如何被建立或位于哪個目錄下之類的信息不應包括在注釋中。在注釋里，對設計決策中重要的或者不是顯而易見的地方進行說明是可以的，但應避免提供代碼中己清晰表達出來的重復信息。多余的的注釋很容易過時。通常應避免那些代碼更新就可能過時的注釋。注意：第8頁Java語言編碼規(guī)范頻繁的注

7、釋有時反映出代碼的低質量。當你覺得被迫要加注釋的時候，考慮一下重寫代碼使其更清晰。注釋不應寫在用星號或其他字符畫出來的大框里。注釋不應包括諸如制表符和回退符之類的特殊字符?？傊鹤⑨屢鞔_注明文件、頁面、函數(shù)、算法之功能，用途，以及創(chuàng)建、修改信息等。1聲明(Declarations)1.1每行聲明變量的數(shù)量(NumberPerLine)推薦一行一個聲明，因為這樣以利于寫注釋。亦即，intlevel;//indentationlevelintsize;//sizeoftable要優(yōu)于，intlevel,size;不要將不同類型變量的聲明放在同一行，例如

8、：intfoo,fooarray[];//WRONG!注意：上面的例子中，在類型和標識符之間放了一個空格，另