java方法注釋,java方法注釋是自己打上的嗎

本文目錄一覽：

• 1、為什麼要為程序添加註釋，在java程序中如何為程序添加註釋？
• 2、java中的注釋可分為三種類型
• 3、如何在java程序中添加註釋
• 4、java 中的幾種注釋方式
• 5、java方法名前注釋問題
• 6、請列出java中的注釋

為什麼要為程序添加註釋，在java程序中如何為程序添加註釋？

注釋是用來給開發者或者是軟件後續的維護者來看的。一般是用來描述這一段代碼或者是程序做了些什麼樣的事情。實現了哪些功能，java裡面注釋代碼，可以分為行注釋和塊注釋，方法注釋等。

行注釋就是在需要注釋的代碼前加 //

塊注釋則是用 /* 和 */ 把文本段落框起來即可

java中的注釋可分為三種類型

Java中三種類型的注釋：

單行注釋：// 注釋內容

多行注釋：/*… 注釋內容….*/

文本注釋：/**.. 注釋內容….*/

代碼注釋是架起程序設計者與程序閱讀者之間的通信橋樑，最大限度的提高團隊開發合作效率。也是程序代碼可維護性的重要環節之一。所以不是為寫注釋而寫注釋。

備註：簡單的代碼做簡單注釋，注釋內容不大於10個字即可，另外，持久化對象或VO對象的getter、setter方法不需加註釋。

擴展資料：

類（模塊）注釋採用 /** …… */，在每個類（模塊）的頭部要有必要的注釋信息，包括：工程名；類（模塊）編號；命名空間；類可以運行的JDK版本；版本號；作者；創建時間；類（模塊）功能描述（如功能、主要算法、內部各部分之間的關係、該類與其類的關係等，必要時還要有一些如特別的軟硬件要求等說明）；主要函數或過程清單及本類（模塊）歷史修改記錄等。

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

如何在java程序中添加註釋

1、單行(single-line)–短注釋：//…… 單獨行注釋：在代碼中單起一行注釋， 注釋前最好有一行空行，並與其後的代碼具有一樣的縮進層級。如果單行無法完成，則應採用塊注釋。 注釋格式：/* 注釋內容 */ 行頭注釋：在代碼行的開頭進行注釋。主要為了使該行代碼失去意義。 注釋格式：// 注釋內容 行尾注釋：尾端(trailing)–極短的注釋，在代碼行的行尾進行注釋。一般與代碼行後空8（至少4）個格，所有注釋必須對齊。 注釋格式：代碼 + 8（至少4）個空格 + // 注釋內容

2、塊(block)–塊注釋：/*……*/ 注釋若干行，通常用於提供文件、方法、數據結構等的意義與用途的說明，或者算法的描述。一般位於一個文件或者一個方法的前面，起到引導的作用，也可以根據需要放在合適的位置。這種域注釋不會出現在HTML報告中。注釋格式通常寫成： /* * 注釋內容 */

3、文檔注釋：/**……*/ 注釋若干行，並寫入javadoc文檔。每個文檔注釋都會被置於注釋定界符 /**……*/ …

java 中的幾種注釋方式

我看動力節點的java基礎大全301集教中的三種注釋方法：

1、單行注釋   //注釋的內容

2、多行注釋  /*……*/

3、/**……*/，這種方式和第二種方式相似。這種格式是為了便於javadoc程序自動生成文檔。

下面介紹一下Javadoc的標記：

特別聲明：

（1）javadoc針對public類生成注釋文檔

（2）javadoc只能在public、protected修飾的方法或者屬性之上

（3）javadoc注釋的格式化：前導*號和HTML標籤

（4）javadoc注釋要僅靠在類、屬性、方法之前

下面主要舉例說明第三種注釋的應用：

（1）首先編寫.java文件

（2）在命令行中執行以下dos命令：

javadoc *.java //根據相應的Java源代碼及其說明語句生成HTML文檔

//javadoc標記：是@開頭的，對javadoc而言，特殊的標記。

（3）在當前目錄下就會產生doc文件夾，裡面有一系列的.html文件

附上代碼：

[java] view plain copy

span style=”font-size:18px;”*/

/**javadoc注釋的內容

*/

public class Hello{

/**屬性上的注釋*/

public String name;

/**這是main方法,是程序的入口

*@param args 用戶輸入參數

*/

public static void main(String[] args){

System.out.println(“Hello World!”);

f1();

}

/** 這是第1個方法,其作用是…*/

public static void f1(){

System.out.println(“f1()！”);

}

}/span

[java] view plain copy

span style=”font-size:18px;”import java.io.IOException;

/**javadoc注釋內容

*@since 1.0

*@version 1.1

*@author Blue Jey

*br鏈接到另一個文檔{@link Hello},就這些

*see Hello

*/

public class HelloWorld{

/**非public，protected 屬性上的注釋不生成*/

public String name;

/**這是main方法，是程序的入口

*@param args 用戶輸入的參數，是數組

*@throws IOException main方法io異常

*/

public static void main(String args[]) throws IOException{

System.out.println(“hello World!”);

f1();

f2(1);

}

/**這是第一個方法，其作用是….

*@deprecated 從版本1.2開始，不再建議使用此方法

*/

public static void f1(){

System.out.println(“fl()!”);

}

/**這是第二個方法，其作用是….

*@return 返回是否OK

*@param i 輸入參數i

*@see Hello

*@throws IOException io異常

*/

public static String f2(int i)throws IOException{

System.out.println(“f1()!”);

return “OK”;

}

} /span

注意：

如果源文件中有用到@version,@author標記，則在執行javadoc命令時，要加-version -author

javadoc -version -author -d doc *.java

（其中用-version用於提取源文件中的版本信息 -author用於提取源文件中的作者信息）

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直接生成相關文檔，文檔注釋的基本格式為“/**…*/”，不僅僅如此，文檔注釋本身還存在語法