JAVA中的注釋方法


Java的三種注釋方法

①單行注釋:使用 // ,其注釋內容從//開始到本行結束,比較常用,

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

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

②多行注釋:配套使用 /* */ ,可以將一段比較長的注釋括起來,注意不能嵌套使用,

      快捷鍵為:Ctrl  + Shift + /     

      取消注釋:Ctrl + Shift + \

③文檔注釋:這種注釋方法以 /** 開始,以 */ 結束,

      快捷鍵:Alt + Shift + J

Java文檔注釋詳細說明

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

1、注釋的插入

  ①javadoc實用程序(utility)從以下特性抽取信息:包、共有類與接口、公有的和受保護的構造器及方法、公有的和受保護的域;

  ②應該為上面幾部分編寫注釋,並且注釋應該放置在所描述特性的前面;

  ③文檔注釋為 /** 開始,並以 */ 結束;

  ④每個/** ... */文檔注釋在標記之后緊跟着自由格式文本,標記由@開始,如@author或@param;

  ⑤在自由格式文本中,可以使用HTML修飾符,例如,用於強調的<em>...</em>、用於着重強調的<strong>...</strong>以及包含圖像的<img ...>等,

      但是不能使用<h1>或<hr>,因為它們會與文檔的格式產生沖突;

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

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

       javadoc實用程序將從源目錄拷貝這些目錄及其中的文件到文檔目錄中。

       在鏈接中需要使用doc-files目錄 , 例如:<img src= “doc-files/uml.png” alt= “ UMLdiagram ” >。

2、類注釋

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

3、方法注釋

  每一個方法注釋必須放在所描述的方法之前。除了通用標記之外,還可以使用下面的標記:

  ①@param變量描述

    這個標記將對當前方法的“param”(參數)部分添加一個條目。這個描述可以占據多行,並可以使用HTML標記。一個方法的所有@param標記必須放在一起。

  ②@return描述

    這個標記將對當前方法添加“return”(返回)部分。這個描述可以跨越多行,並可以使用HTML標記。

  ③@throws類描述

    這個標記將添加一個注釋, 用於表示這個方法有可能拋出異常。

4、域注釋

  只需要對公有域(通常指的是靜態常量)。例如:

 

1 /**
2  * The "Hearts" card suit 3  */
4 public static final int HEARTS = 1;
域注釋例子

 

5、通用注釋

 

@author 姓名 作者條目
@version 文本 版本條目
@since 文本 始於條目
@deprecated 文本  
@see 引用  

以上內容參考《Java核心技術 卷Ⅰ》


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM