java文檔注釋,Java文檔注釋怎麼注釋

本文目錄一覽：

• 1、java 中的幾種注釋方式
• 2、如何寫Java文檔注釋
• 3、java中」 /** */」注釋和」 /* */」注釋 有什麼區別嗎？
• 4、Java如何進行單行注釋和多行注釋？

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文檔注釋

/**

* @author

* @param name

* @copy

*/

表示的是文檔注釋，文檔注釋里可以以作者名，參數的意義，版本等等。對於方法的文檔注釋，可以在方法的上面輸入「/**」按回車，就會出來了

java中」 /** */」注釋和」 /* */」注釋 有什麼區別嗎？

1、/**/只代表單純的注釋 ，java文檔注釋

2、/***/ 不僅有注釋的功效而且你鼠標放在你注釋的方法上面他會把你注釋的內容顯示出來，

3、只要把鼠標放在你注釋的方法或屬性上就會顯示了

Java如何進行單行注釋和多行注釋？

（1）單行注釋：以「 // 」開頭後面接所要加的說明的內容。如下面所示： //定義變量a int a = 10; //定義變量b int b = 20;上面的語句中，在編譯的過程就會直接略過注釋，只會編譯 int a = 10 和 int b = 20這兩句。由此可見注釋只是起着說明的作用。

（2）多行注釋：以「/*」開頭，以「*/」結尾。 假設當你要說明你所寫的代碼的功能時。要說明的內容有很多。如果全部放在同一行會顯得很難看。所以一般會用多行來寫，如下所示// 說明//說明//說明//說明以上是用四個單行注釋來注釋四行說明。但如果有10行說明就要按十個「//」這顯示很麻煩，所以這時就可採用多行注釋。上面的可改成：/*說明說明說明說明*/也可以這樣/* 說明 說明 說明 說明 */

（3）文檔注釋：以「/**」開頭，以「*/」結尾。文檔注釋主要是生成文檔的。