j2ee項(xiàng)目代碼規(guī)范文檔-全文預(yù)覽
【正文】 以把他們統(tǒng)稱為行注釋，因?yàn)樗鼈兊淖⑨岋L(fēng)格都不換行，都在同一行內(nèi)。 ** 進(jìn)行權(quán)限判斷* (,)。 } 注：標(biāo)簽后邊空格類名，空格注釋：但是注釋會把類名覆蓋掉，所以最好不加注釋，只寫類名。塊注釋一般位于一個(gè)文件或一個(gè)方法的前面，當(dāng)然如需要它可以位于任意的地方，如方法體內(nèi)。程序頭注釋參考部分的內(nèi)容，下面主要提供程序?qū)崿F(xiàn)代碼注釋的原則。程序注釋注釋在程序中是相當(dāng)重要的一部分，注釋的目的在于說明程序，給自己或他人在閱讀程序時(shí)提供幫助，使程序更容易理解，也就是增強(qiáng)程序代碼的可讀性。 ) { ...}* 鍵（空格鍵）深度折行* ( ,貓蠆驢繪燈鮒誅髏貺廡獻(xiàn)鵬縮。 * ( – ) * *良好的風(fēng)格*此例中我們采用了折行規(guī)則中的折行原則：高層折行優(yōu)于底層折行。(, , ,買鯛鴯譖曇膚遙閆擷凄屆嬌擻。折行規(guī)則當(dāng)完整的一行代碼難以編排在同一個(gè)代碼行中時(shí)，我們可以根據(jù)下面的規(guī)則，對源代碼進(jìn)行折行編排：在逗號后折行；在運(yùn)算符（）前折行；高層折行優(yōu)于底層折行；折下的代碼行應(yīng)該與其同等級的代碼行左對齊。代碼行長度與折行規(guī)則代碼行長度一般來說的代碼行長度應(yīng)該小于個(gè)字符，超過這個(gè)長度可能在一些開發(fā)工具或編譯器上就無法很好地顯示，而且也會給閱讀程序帶來麻煩。源文件編排格式源文件的一般編排格式中的行間縮緊，是以四個(gè)空格鍵（）為單位的，當(dāng)然這并沒有權(quán)威的文獻(xiàn)可做參考，只是對一般情況而言是這樣的，這樣看起來代碼格式更清晰、更具美感。表 類與接口的聲明序號類與接口的聲明聲明規(guī)則類與接口文件頭的注釋應(yīng)采用（**…*）的注釋格式具體的書寫格式及其內(nèi)容，參考部分類與接口的聲明類與接口的名字一般由大寫字母開頭，其他字母都小寫的單詞組成，并且類的名字應(yīng)盡量具有清晰的實(shí)際意義類與接口實(shí)現(xiàn)部分的注釋應(yīng)采用（*…*）的注釋格式這種注釋方式一般適用于類的接口中較大區(qū)域的注釋，而對類與接口文件頭的注釋，則不適用類的變量的聲明首先應(yīng)該聲明公共（）類型的變量，再聲明保護(hù)（）類型的變量，最后聲明私有（）類型的變量實(shí)例（）變量的聲明與類的變量聲明順序一樣，首先應(yīng)該聲明公共（）類型的變量，再聲明保護(hù)（）類型的變量，最后聲明私有（）類型的變量構(gòu)造器（）的聲明構(gòu)造器一般作為類的第一個(gè)方法聲明，你可以在構(gòu)造器的聲明體中加入一些與處理代碼方法（）的聲明方法的聲明最好采用以功能性分組的方式進(jìn)行排列，這比采用可訪問性分組的方式排列更為友好，例如：可以將一個(gè)私有方法放在兩個(gè)公共方法之間，這樣做是為了把功能性相近的方法排列在一個(gè)組中。 。一般情況下源文件的第一行都是類本身的包名描述部分（如果有包名的話）。下面給出了包的基本命名規(guī)則，之所以說是基本，是因?yàn)榭梢栽谔厥獾那闆r下采用特殊的命名方法，凡事應(yīng)具體情況具體分析。煢楨廣鰳鯡選塊網(wǎng)羈淚鍍齊鈞。主要用到的注釋有：彈貿(mào)攝爾霽斃攬磚鹵廡詒爾膚。如表所示。聞創(chuàng)溝燴鐺險(xiǎn)愛氌譴凈禍測樅。文件注釋頭.包的聲明與引用.類與接口的聲明源文件編排格式.代碼行長度與折行規(guī)則.代碼行長度.折行規(guī)則.程序注釋.程序?qū)崿F(xiàn)代碼注釋.注釋規(guī)則.變量的聲明初始化與放置.變量聲明.變量初始化.變量放置程序語句編寫規(guī)則.簡單語句.復(fù)合語句.空格與空行的應(yīng)用規(guī)則.空格的應(yīng)用規(guī)則.空行的應(yīng)用規(guī)則.方法、變量與常量的命名規(guī)則.方法的命名規(guī)則.變量的命名規(guī)則.常量的命名規(guī)則序通常說來優(yōu)秀的開發(fā)人員一般都有良好的程序設(shè)計(jì)風(fēng)格，優(yōu)秀的管理人員會在自己的開發(fā)團(tuán)隊(duì)中灌輸養(yǎng)成良好程序設(shè)計(jì)風(fēng)格的意識，優(yōu)秀的軟件企業(yè)都有自己一套健全、成熟的程序設(shè)計(jì)風(fēng)格規(guī)范文檔，用以規(guī)范開發(fā)人員編寫代碼的風(fēng)格。文件名與文件組織結(jié)構(gòu)文件名由實(shí)意文件名后綴組成，后綴名因類型的不同而不同。每一個(gè)源文件一般由下面的順序構(gòu)成：（）文件注釋頭（）包名（）（）引入（）聲明（）類（）或接口（）的聲明部分文件注釋頭類文件注釋頭是用來描述該類功能及其特點(diǎn)，以及相關(guān)開發(fā)信息的，如該類的關(guān)聯(lián)類（通常情況下不描述系統(tǒng)核心類如, 等）、開發(fā)公司或單位、版權(quán)、作者、代碼審定人該類所支持的版本、該類版本、開發(fā)日期、最后更改日期、修改人、復(fù)審人等信息。文件注釋頭包
公司管理相關(guān)推薦
鄂ICP備17016276號-1