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程序中添加註釋

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

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

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

什麼是注釋？如何在Java程序中加入注釋？

試想一下，一個沒有一句注釋的程序源碼，怎麼讀，一個程序要上萬條代碼不可能全部記得住哪一塊是什麼用，而且一個項目也不會是一個人獨自完成，那樣效率太低，多人合作就要給別人說明，每一塊是什麼用，方便他人使用，方便自己更正，而這些說明文字就是注釋，注釋不會被執行，不影響運行結果。

Java中代碼的注釋有三種：

// 注釋一行 

/* …… */ 注釋若干行 

/** …… */ 注釋若干行，並寫入 javadoc 文檔

前兩種比較容易理解，至於第三種，你學習Java看的api文檔就是javadoc程序根據第三種的注釋生成的。

擴展資料

注釋就是對代碼的解釋和說明，其目的是讓人們能夠更加輕鬆地了解代碼。注釋是編寫程序時，寫程序的人給一個語句、程序段、函數等的解釋或提示，能提高程序代碼的可讀性。

java 怎樣給源代碼添加註釋

1、單行(single-line)–短注釋：//……

單獨行注釋：在代碼中單起一行注釋，

注釋前最好有一行空行，並與其後的代碼具有一樣的縮進層級。如果單行無法完成，則應採用塊注釋。

注釋格式：/*

注釋內容

*/

行頭注釋：在代碼行的開頭進行注釋。主要為了使該行代碼失去意義。

注釋格式：//

注釋內容

行尾注釋：尾端(trailing)–極短的注釋，在代碼行的行尾進行注釋。一般與代碼行後空8（至少4）個格，所有注釋必須對齊。

注釋格式：代碼

+

8（至少4）個空格

+

//

注釋內容

2、塊(block)–塊注釋：/*……*/

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

/*

*

注釋內容

*/

3、文檔注釋：/**……*/

注釋若干行，並寫入javadoc文檔。每個文檔注釋都會被置於注釋定界符

/**……*/

…