資源描述：
《java 語言編碼規(guī)范》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫。
1、Java語言編碼規(guī)范Java語言編碼規(guī)范第8頁Java語言編碼規(guī)范目錄一、規(guī)范簡介11目的12范圍13參考文檔14說明1二、JAVA編碼規(guī)范12縮進(jìn)排版(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對(duì)象57.2可移植性57.3換行57.4PrintStream6三、JSP編碼規(guī)范6四、SERVLET編碼規(guī)范7五、JSP和SERVLET編程注意事項(xiàng)7六、代碼范例(CODEEXAMPLES)7第8頁Java語言編碼規(guī)范一、規(guī)范簡介1目的制訂本規(guī)范的目的是為培養(yǎng)規(guī)范設(shè)計(jì)和編程，養(yǎng)成良好的習(xí)慣，增強(qiáng)JAVA類軟件產(chǎn)品的穩(wěn)定、健壯、可靠性;同時(shí)也為提高軟件的可讀性，可以讓程序員盡快而徹底地理解新的代碼，使產(chǎn)品可維護(hù)性提高而制定的強(qiáng)制性規(guī)范，同時(shí)也是代碼復(fù)審的依據(jù)。2范圍本規(guī)范適用于公司JAVA類代碼（包括JSP）的代碼編寫標(biāo)
3、準(zhǔn)。適用于代碼編寫階段和代碼維護(hù)階段。3參考文檔《SUNJAVA代碼編寫規(guī)范》。4說明本文檔包括java編碼規(guī)范，jsp編碼規(guī)范，servlet編碼規(guī)范。struts代碼規(guī)范請(qǐng)參閱《struts編碼規(guī)范.doc》。二、java編碼規(guī)范1.1.1開頭注釋(BeginningComments)所有的源文件都應(yīng)該在開頭有一個(gè)Java語言風(fēng)格的注釋，其中列出標(biāo)題、描述、日期和版權(quán)聲明：/***
Title:標(biāo)題
*
Description:描述
*
Copyright:Copyright(c)2007
*
Company:華
4、勝天成
*@author:張三*@version1.0*/第8頁Java語言編碼規(guī)范1.1.1包和引入語句(PackageandImportStatements)在多數(shù)Java源文件中，第一個(gè)非注釋行是包語句。在它之后可以跟引入語句。例如：packagejava.awt;importjava.awt.peer.CanvasPeer;注：避免使用以下方式importjava.awt.*;2縮進(jìn)排版(Indentation)4個(gè)空格常被作為縮進(jìn)排版的一個(gè)單位?？s進(jìn)的確切解釋并未詳細(xì)指定(空格vs.制表符)。一個(gè)制表符等于8個(gè)空格(而非4個(gè))。2.1
5、行長度(LineLength)盡量避免一行的長度超過80個(gè)字符，因?yàn)楹芏嘟K端和工具不能很好處理之。注意：用于文檔中的例子應(yīng)該使用更短的行長，長度一般不超過70個(gè)字符。3注釋(Comments)Java程序原有兩類注釋：實(shí)現(xiàn)注釋(implementationcomments)和文檔注釋(documentcomments)，我們自己又增加了一種注釋叫標(biāo)記注釋。實(shí)現(xiàn)注釋是那些在C++中見過的，使用/*...*/和//界定的注釋。文檔注釋(被稱為"doccomments")是Java獨(dú)有的，并由/**...*/界定。文檔注釋可以通過javadoc工具轉(zhuǎn)換成H
6、TML文件。實(shí)現(xiàn)注釋用以注釋代碼或者實(shí)現(xiàn)細(xì)節(jié)。文檔注釋從實(shí)現(xiàn)自由(implementation-free)的角度描述代碼的規(guī)范。它可以被那些手頭沒有源碼的開發(fā)人員讀懂。注釋應(yīng)被用來給出代碼的總括，并提供代碼自身沒有提供的附加信息。注釋應(yīng)該僅包含與閱讀和理解程序有關(guān)的信息。例如，相應(yīng)的包如何被建立或位于哪個(gè)目錄下之類的信息不應(yīng)包括在注釋中。在注釋里，對(duì)設(shè)計(jì)決策中重要的或者不是顯而易見的地方進(jìn)行說明是可以的，但應(yīng)避免提供代碼中己清晰表達(dá)出來的重復(fù)信息。多余的的注釋很容易過時(shí)。通常應(yīng)避免那些代碼更新就可能過時(shí)的注釋。注意：第8頁Java語言編碼規(guī)范頻繁的注
7、釋有時(shí)反映出代碼的低質(zhì)量。當(dāng)你覺得被迫要加注釋的時(shí)候，考慮一下重寫代碼使其更清晰。注釋不應(yīng)寫在用星號(hào)或其他字符畫出來的大框里。注釋不應(yīng)包括諸如制表符和回退符之類的特殊字符?？傊鹤⑨屢鞔_注明文件、頁面、函數(shù)、算法之功能，用途，以及創(chuàng)建、修改信息等。1聲明(Declarations)1.1每行聲明變量的數(shù)量(NumberPerLine)推薦一行一個(gè)聲明，因?yàn)檫@樣以利于寫注釋。亦即，intlevel;//indentationlevelintsize;//sizeoftable要優(yōu)于，intlevel,size;不要將不同類型變量的聲明放在同一行，例如
8、：intfoo,fooarray[];//WRONG!注意：上面的例子中，在類型和標(biāo)識(shí)符之間放了一個(gè)空格，另
