j2ee項目代碼規(guī)范文檔-在線瀏覽
2025-06-03 05:38本頁面
【正文】 下不描述系統(tǒng)核心類如, 等）、開發(fā)公司或單位、版權、作者、代碼審定人該類所支持的版本、該類版本、開發(fā)日期、最后更改日期、修改人、復審人等信息。使用格式空格類名（不能帶） 版本號 作者 自從（標識類從什么版本開始使用比如：版本新增類，可以使用這個注釋進行說明） 開發(fā)日期*繼承，實現(xiàn)接口，被繼承，會自動生成下面就是一個類文件注釋頭：****************************************************************謀蕎摶篋飆鐸懟類蔣薔點鉍雜。文件注釋頭包括, , , , 等標記，是為了通過聲稱 標準文檔做準備的。包的聲明與引用我們在做開發(fā)時常會引用（）核心類或者第三方軟件廠商的類，一般情況下，這些類都是封裝在一個包（）里面的，包概念的出現(xiàn)，使類（）有了名稱空間的細致劃分，使龐大復雜的類群有了較為清晰的分支，形成了清晰脈絡。鵝婭盡損鵪慘歷蘢鴛賴縈詰聾。一般有如下規(guī)則：籟叢媽羥為贍僨蟶練淨櫧撻曉。域名之前的國家名稱可以由一到兩個英文字母做前綴用來表示國家名稱，這個規(guī)則可以參考標準；域名后面的部分可以根據習慣命名。在這之后就是我們引用系統(tǒng)核心包或第三方包的描述部分。 。 。鐃誅臥瀉噦圣騁貺頂廡縫勵羆。這樣做的目的是為了使代碼具有更強的可讀性與易解性析構器（）()方法其實程序設計中，本來沒有析構器的概念，我們這里只是形象稱()方法為析構器。擁締鳳襪備訊顎輪爛薔報贏無。四個空格鍵相當于半個鍵。贓熱俁閫歲匱閶鄴鎵騷鯛漢鼉。因此，我們應盡量避免超過個字符長度的代碼行。壇摶鄉(xiāng)囂懺蔞鍥鈴氈淚躋馱釣。如果上面的法則另代碼行右側距頁邊的距離，差距較大并且混亂，我們可以在適當行采用鍵（空格鍵）處理?？匆韵碌膽脤嵗悍椒ㄕ{用折行實例。, )。運算符前折行與高層折行優(yōu)于低層折行實例。這樣做的好處是能使程序的結構更清楚，更容易被人理解。鍵（空格鍵）處理法則：*習慣深度折行*( , , ,驅躓髏彥浹綏譎飴憂錦諑瓊針。 , , ) { ...}以上兩個方法的折行都是可以接受的，但是第二種折行風格更美觀一些。鍬籟饗逕瑣筆襖鷗婭薔嗚訝擯。嚴格意義上說一份代碼應該有的注釋內容，我們要求一份代碼有不少與的注釋量。注釋在程序中分為兩類：程序頭注釋與程序實現(xiàn)代碼注釋。輒嶧陽檉籪癤網儂號澩蠐鑭釃。塊注釋代碼塊注釋經常被用于提供文件、方法、數據結構、變量的意義與用途，以及算法的描述。堯側閆繭絳闕絢勵蜆贅瀝紕縭。 。方法內塊注釋位于方法體內的塊注釋應該與其所描述的代碼位于同一個層次上。塊注釋以“*”開始，以“*”終結，例如：識饒鎂錕縊灩筧嚌儼淒儂減攙。凍鈹鋨勞臘鍇癇婦脛糴鈹賄鶚。 }行注釋行注釋又分為三種：單獨行注釋、行尾注釋與行頭注釋。恥諤銪滅縈歡煬鞏鶩錦聰櫻鄶。單獨行注釋一般用于對較短的注釋信息的描述。例如：鯊腎鑰詘褳鉀溈懼統(tǒng)庫搖飭緡。 * 如果等于則返回真*} { * 如果不等于則返回假*}……行頭注釋行頭注釋是用來注釋代碼的，使代碼失去意義，行頭注釋在程序調試中經常被用到，如果注釋的代碼行過多并且更改頻繁，請采用塊注釋以提高效率?！?( ){*做相應處理*…} { 。 *否則返回假* }……類注釋與注釋在方法的上方注釋對此方法的描述、返回值。例如：** * 獲得備注 * 備注 * () { 。 }在方法的上方注釋對此方法的描述、參數、返回值。例如：** * 實現(xiàn)舉報信息查詢全部信息功能 * 舉報投訴 * 權限 * 查詢后的信息 * ( ){閿擻輳嬪諫遷擇楨秘騖輛塤鵜。 } { 39。氬嚕躑竄貿懇彈瀘頷澩紛釓鄧。39。 。 ()。 }注釋規(guī)則注釋是對代碼的“提示”，而不是文檔；如果代碼本來就是清楚的，則不必加注釋；邊寫代碼邊加注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。完整的包括文件注釋頭和實現(xiàn)代碼注釋的代碼風格如下所示：*************************
公司管理相關推薦
鄂ICP備17016276號-1