java方法注釋,java方法注釋規範

本文目錄一覽：

• 1、java方法名前注釋問題
• 2、請列出java中的注釋
• 3、java 文檔注釋是注釋什麼的,不是有多行注釋了嗎?

java方法名前注釋問題

Java註解是附加在代碼中的一些元信息，用於一些工具在編譯、運行時進行解析和使用，起到說明、配置的功能。

註解不會也不能影響代碼的實際邏輯，僅僅起到輔助性的作用。包含在 java.lang.annotation 包中。

1、元註解

元註解是指註解的註解。包括 @Retention @Target @Document @Inherited四種。

1.1、@Retention: 定義註解的保留策略

@Retention(RetentionPolicy.SOURCE) //註解僅存在於源碼中，在class字節碼文件中不包含

@Retention(RetentionPolicy.CLASS) // 默認的保留策略，註解會在class字節碼文件中存在，但運行時無法獲得，

@Retention(RetentionPolicy.RUNTIME) // 註解會在class字節碼文件中存在，在運行時可以通過反射獲取到

1.2、@Target：定義註解的作用目標

@Target(ElementType.TYPE) //接口、類、枚舉、註解

@Target(ElementType.FIELD) //字段、枚舉的常量

@Target(ElementType.METHOD) //方法

@Target(ElementType.PARAMETER) //方法參數

@Target(ElementType.CONSTRUCTOR) //構造函數

@Target(ElementType.LOCAL_VARIABLE)//局部變量

@Target(ElementType.ANNOTATION_TYPE)//註解

@Target(ElementType.PACKAGE) ///包

由以上的源碼可以知道，他的elementType 可以有多個，一個註解可以為類的，方法的，字段的等等

1.3、@Document：說明該註解將被包含在javadoc中。

1.4、@Inherited：說明子類可以繼承父類中的該註解。

請列出java中的注釋

在Java裡面主要有三種注釋：行注釋、段落注釋、文檔注釋

1)行注釋：行注釋也成為單行注釋，行注釋使用 “//注釋文字”的格式來對某一行的代碼進行注釋或者加以說明

2)段注釋：段注釋也成為多行注釋，通常是當說明文字比較長的時候的注釋方法

3)文檔注釋：文檔注釋是Java裡面的一個比較厲害的功能，它可以用於注釋類、屬性、方法等說明，而且通過JDK工具javadoc直接生成相關文檔，文檔注釋的基本格式為“/**…*/”，不僅僅如此，文檔注釋本身還存在語法

java 文檔注釋是注釋什麼的,不是有多行注釋了嗎?

1、【文檔注釋】是寫在類或者方法的上面的。

文檔注釋可以用eclipse導出chm格式的幫助文檔，拿給其他人用時，方便他人理解。文檔注釋被調用的方法，當鼠標移到上面時提醒注釋內容。

使用文檔注釋時，需要在開始的 /** 之後，第一行或幾行是關於類、變量和方法的主要描述。

之後，可以包含一個或多個何種各樣的@ 標籤。每一個@標籤必須在一個新行的開始或者在一行的開始緊跟星號(*)。多個相同類型的標籤應該放成一組。

2、【多行注釋】注釋的也是方法或類，言下之意就是一次性的將程序中的多行代碼注釋掉，但多行注釋的內容不能用於生成一個開發者文檔。

3、【多行注釋與文檔注釋的區別】多行注釋的內容不能用於生成一個開發者文檔，而文檔注釋的內容可以生產一個開發者文檔。

擴展資料

java常用的文檔注釋標籤

1、@author：標識一個類的作者

實例： @authordescription

2、@deprecated：指名一個過期的類或成員

實例： @deprecateddescription

3、@exception：標誌一個類拋出的異常

實例：@exceptionexception-nameexplanation

4、{@inheritDoc}：從直接父類繼承的注釋

實例：Inheritsacommentfromtheimmediatesurperclass.

5、{@link}：插入一個到另一個主題的鏈接

實例：{@linknametext}

6、{@linkplain}：插入一個到另一個主題的鏈接，但是該鏈接顯示純文本字體

實例：Insertsanin-linelinktoanothertopic.

7、@param：說明一個方法的參數

實例：@paramparameter-nameexplanation

8、@return：說明返回值類型

實例：@returnexplanation

9、@see：指定一個到另一個主題的鏈接

實例：@seeanchor

10、@serial：說明一個序列化屬性

實例：@serialdescription

參考資料：百度百科-java注釋