Java的三種注釋方法

①單行注釋：使用//，其注釋內(nèi)容從//開(kāi)始到本行結(jié)束，比較常用，

快捷鍵為：Ctrl+/或者Ctrl+Shift+C

取消注釋：Ctrl+/或者Ctrl+Shift+C

②多行注釋：配套使用/*和*/,可以將一段比較長(zhǎng)的注釋括起來(lái)，注意不能嵌套使用，

快捷鍵為：Ctrl+Shift+/

取消注釋：Ctrl+Shift+\

③文檔注釋：這種注釋方法以/**開(kāi)始，以*/結(jié)束，

快捷鍵：Alt+Shift+J

Java文檔注釋詳細(xì)說(shuō)明

JDK包含的Javadoc工具可以有源文件生成一個(gè)HTLM文檔，這種方式可以將代碼與注釋保存在一個(gè)地方。

1.注釋的插入

①javadoc實(shí)用程序（utility）從以下特性抽取信息：包、共有類與接口、公有的和受保護(hù)的構(gòu)造器及方法、公有的和受保護(hù)的域；

②應(yīng)該為上面幾部分編寫(xiě)注釋，并且注釋?xiě)?yīng)該放置在所描述特性的前面；

③文檔注釋為/**開(kāi)始，并以*/結(jié)束；

④每個(gè)/**...*/文檔注釋在標(biāo)記之后緊跟著自由格式文本，標(biāo)記由 開(kāi)始，如 author或 param；

⑤在自由格式文本中，可以使用HTML修飾符，例如，用于強(qiáng)調(diào)的<em>...</em>、用于著重強(qiáng)調(diào)的<strong>...</strong>以及包含圖像的<img...>等，

但是不能使用<h1>或<hr>，因?yàn)樗鼈儠?huì)與文檔的格式產(chǎn)生沖突；

⑥在自由格式文本中，若要鍵入等寬代碼，需使用{ code...}，而不是<code>...</code>，這樣避免了對(duì)代碼中<字符的轉(zhuǎn)義。

注：如采文檔中有到其他文件的鏈接，例如，圖像文件（用戶界面的組件的圖表或圖像等），就應(yīng)該將這些文件放到子目錄doc-files中。

javadoc實(shí)用程序?qū)脑茨夸浛截愡@些目錄及其中的文件到文檔目錄中。

在鏈接中需要使用doc-files目錄，例如：＜img src=“doc-files/uml.png”alt＝“UMLdiagram”＞。

2.類注釋

類注釋必須放在import i再句之后，類定義之前。

3.方法注釋

每一個(gè)方法注釋必須放在所描述的方法之前。除了通用標(biāo)記之外，還可以使用下面的標(biāo)記：

① param變量描述

這個(gè)標(biāo)記將對(duì)當(dāng)前方法的“param”（參數(shù)）部分添加一個(gè)條目。這個(gè)描述可以占據(jù)多行，并可以使用HTML標(biāo)記。一個(gè)方法的所有 param標(biāo)記必須放在一起。

② return描述

這個(gè)標(biāo)記將對(duì)當(dāng)前方法添加“return”（返回）部分。這個(gè)描述可以跨越多行，并可以使用HTML標(biāo)記。

③ throws類描述

這個(gè)標(biāo)記將添加一個(gè)注釋，用于表示這個(gè)方法有可能拋出異常。

4.域注釋

只需要對(duì)公有域（通常指的是靜態(tài)常量）。例如：

/**
*?The?"Hearts"?card?suit
*/
public?static?final?int?HEARTS?=?1;

5.通用注釋

以上就是動(dòng)力節(jié)點(diǎn)java培訓(xùn)機(jī)構(gòu)的小編針對(duì)“Java的三種注釋方法，趕快學(xué)習(xí)起來(lái)”的內(nèi)容進(jìn)行的回答，希望對(duì)大家有所幫助，如有疑問(wèn)，請(qǐng)?jiān)诰€咨詢，有專業(yè)老師隨時(shí)為你服務(wù)。