簡體中文 | 繁體中文

大話設計模式-----第4章


都市特種狂兵 飛來橫禍:惹上薄情撒旦 一寵成婚:妖孽總裁別太壞 但求魂夢長相依 你是我的兩小無猜 小妾退散 九黎神道 亂世獵人 修羅劍魔 半魔神 化器飛昇 後宮如懿傳(全) 美人謀:禍國公主太妖嬈 阿茶 搜靈 超級抽獎系統 冥夫大人:有話好好說 大杯也能罩 老徐記麵館 穿越之我的網王老公
第4章

大B:“呵呵呵!寫得不錯,不虧是C大的高材生。”

小A:“師兄你這不是在取笑我嘛!我還有好多問題得請教你哩!”

大B:“行行行……沒問題。小師弟好學,師兄哪能袖手旁觀吶!對了,你寫程式碼的時候一定要注意程式碼的規範。”

小A:“程式碼規範?”

大B:“嗯,來來來,我說給你聽。首先是要注意註釋文件的格式,註釋文件將用來生成HTML格式的程式碼報告,所以註釋文件必須書寫在類、域、建構函式、方法、定義之前。註釋文件由兩部分組成——描述、塊標記。”

例如:

註釋

@author大。

@version1.10

publicvoiddoGet(HttpServletRequestrequest,HttpServletResponseresponse)

throwsServletException,IOException{

doPost(request,response);

}

大B:“看!前兩行為描述,描述完畢後,由@符號起頭為塊標記。”

大B:“然後是註釋的種類。有檔案頭註釋、建構函式註釋、域註釋、方法註釋和定義註釋。”

小A:“什麼?註釋還有那麼多的種類的?我以前都沒有用心去記過它的喔。師兄能不能給我講講每一種註釋的功能和要求啊?”

大B:“這有什麼問題哩!舉些例子來講,那樣你就容易理解多了。”

小A:“嘿嘿!那感情好。”

大B:“檔案頭註釋已結束,需要註明該檔案建立時間,檔名,名稱空間資訊。”

例如:

描述部分用來書寫該類的作用或者相關資訊,塊標記部分必須註明作者和版本。

如:

classWindowextendsBaseWindow{

……

}

大B:“建構函式註釋採用描述部分註明建構函式的作用,不一定有塊標記部分。域註釋可以出現在註釋文件裡面,也可以不出現在註釋文件裡面。用的域註釋將會被認為是註釋文件出現在最終生成的HTML報告裡面,而使用的註釋會被忽略。這個應該注意!”

例如:

booleanisTrigerSuccess=false;

又例如:

booleanisTrigerSuccess=false;

再例如:

intx=1263732;

大B:“還有就是方法註釋,方法註釋採用描述部分註明方法的功能,塊標記部分註明方法的引數,返回值,異常等資訊。定義註釋,規則同域註釋。”

小A:“喔……原註釋還真的是有那麼多種類,每個種類都有不同的功能哩!嘿嘿!看來以後我得更認真學習才行哩!”

大B:“呵呵……你能這麼想就好嘍!對了,小A,註釋塊標記你知道不?”

小A:“註釋塊標?嘿嘿!這個……也不知道……”

大B:“沒關係,我告訴你。首先是標記的順序。”

塊標記將採用如下順序:

……

*

*@param(classes,interfaces,methodsandconstructorsonly)

*@return(methodsonly)

*@exception(@throwsisasynonymaddedinJavadoc1.2)

*@author(classesandinterfacesonly,required)

*@version(classesandinterfacesonly,required.Seefootnote1)

*@see

*@since

*@serial(or@serialFieldor@serialData)

*@deprecated(seeHowandWhenToDeprecateAPIs)

*……

一個塊標記可以根據需要重複出現多次,多次出現的標記按照如下順序:

@author按照時間先後順序(chronological)

@param按照引數定義順序(declaration)

@throws按照異常名字的字母順序(alphabetically)

@see按照如下順序:

@see#field

@see#Constructor(Type,Type……)

@see#Constructor(Typeid,Typeid……)

@see#method(Type,Type……)

@see#method(Typeid,Type,id……)

@seeClass

@seeClass#field

@seeClass#Constructor(Type,Type……)

@seeClass#Constructor(Typeid,Typeid)

@seeClass#method(Type,Type……)

@seeClass#method(Typeid,Typeid……)

@seepackage.Class

@seepackage.Class#field

@seepackage.Class#Constructor(Type,Type……)

@seepackage.Class#Constructor(Typeid,Typeid)

@seepackage.Class#method(Type,Type……)

@seepackage.Class#method(Typeid,Type,id)

@seepackage

小A:“哇噻!塊標記還可以按照時間先後順序,按照引數定義順序,按照異常名字的字母順序哩!師兄,你講得真詳細。看來我得好好得花點心思把它們都記下來才好哩!”

大B:“能記住當然好哩!我再給你講下標記介紹。”

@param標記

@param後面空格後跟著引數的變數名字(不是型別),空格後跟著對該引數的描述。

在描述中第一個名字為該變數的資料型別,表示資料型別的名字前面可以有一個冠詞如:a,an,the。如果是int型別的引數則不需要註明資料型別。例如:

……

*@paramchthechar用用來……

*@paramimagetheimage用來……

*@paramnum一個數字……

……

大B:“對於引數的描述如果只是一短語,最好不要首字母大寫,結尾也不要句號。對於引數的描述是一個句子,最好不要首字母大寫,如果出現了句號這說明你的描述不止一句話。如果非要首字母大寫的話,必須用句號來結束句子。(英文的句號)”

公司內部新增ByRef和ByVal兩個標記,例如:

*@paramimagetheimageByRef用來……

說明該引數是引用傳遞(指標),ByVal可以省略,表示是值傳遞。

大B:“程式碼規範大概要點就是這些了。聽起來好像很多,只要用心,其實也很容易記的。”

小A:“嘿嘿!師兄,你太厲害了!”

推薦小說