java的塊註釋怎麼寫

我看動力節點的java基礎大全301集教中的三種註釋方法：1、單行註釋 //註釋的內容2、多行註釋 /*。

*/3、/**。

*/，這種方式和第二種方式相似。

這種格式是爲了便於javadoc程序自動生成文檔。下面介紹一下Javadoc的標記：特別聲明： （1）javadoc針對類生成註釋文檔 （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*/ /**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()!"); } } [java] view plain copyimport java.io.IOException; /**javadoc註釋內容 *@since 1.0 *@version 1.1 *@author Blue Jey *連結到另一個文檔{@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"; } } 注意：如果源檔案中有用到@version,@author標記，則在執行javadoc命令時，要加-version -author javadoc -version -author -d doc *.java （其中用-version用於提取源檔案中的版本資訊 -author用於提取源檔案中的作者資訊）。

1、單行（single-line）--短註釋：//…… 單獨行註釋：在代碼中單起一行註釋， 註釋前最好有一行空行，並與其後的代碼具有一樣的縮進層級。

如果單行無法完成，則應採用塊註釋。 註釋格式：/* 註釋內容 */ 行頭註釋：在代碼行的開頭進行註釋。

主要爲了使該行代碼失去意義。 註釋格式：// 註釋內容 行尾註釋：尾端（trailing）--極短的註釋，在代碼行的行尾進行註釋。

一般與代碼行後空8（至少4）個格，所有註釋必須對齊。 註釋格式：代碼 + 8（至少4）個空格 + // 註釋內容 2、塊（block）--塊註釋：/*……*/ 註釋若干行，通常用於提供檔案、方法、數據結構等的意義與用途的說明，或者算法的描述。

一般位於一個檔案或者一個方法的前面，起到引導的作用，也可以根據需要放在合適的位置。這種域註釋不會出現在HTML報告中。

註釋格式通常寫成： /* * 註釋內容 */ 3、文檔註釋：/**……*/ 註釋若干行，並寫入javadoc文檔。每個文檔註釋都會被置於註釋定界符 /**。

*/ 。

對於局部變量的註解只能在源碼級別上進行處理，類檔案並不描述局部變量。因此，所有的局部變量註解在編譯完一個類的時候就會被遺棄掉。同樣地，對包的註解不能在源碼級別之外存在。

在檔案package-info.java中註解一個包，該檔案只包含以註解先導的包聲明

包註解需要在特定檔案：package-info.java，中添加，獲取如下：

Package pkg = TestAnnotation.class.getPackage();

boolean hasAnnotation=pkg.isAnnotationPresent(Xpc.class);

if (hasAnnotation){

Xpc xpc=pkg.getAnnotation(Xpc.class);

System.out.println("package:" + pkg.getName());

System.out.println("id=" + xpc.id());

System.out.println("name=" + xpc.name());

System.out.println("gid=" + xpc.gid());

}

如何寫Java文檔註釋（Java Doc Comments）

本文翻譯自How to Write Doc Comments for the Javadoc Tool，但是精簡了一些私以爲不重要的東西

本文不討論如何使用javadoc工具自動生成文檔的方法，而是主要探討應該如何去寫文檔註釋

業餘時間整理，難免有遺漏或錯誤，如有發現歡迎指正

轉載地址：網頁連結

文檔註釋概覽

“文檔註釋”（Java Doc Comments）是專門爲了用javadoc工具自動生成文檔而寫的註釋，它是一種帶有特殊功能的註釋。

文檔註釋與一般註釋的最大區別在於起始符號是/**而不是/*或//。

比如：

/**這是文檔註釋*/

/* 這是一般註釋*/

// 這是一般註釋

在一些IDE（比如Eclipse）中，文檔註釋會以不同於普通註釋的顏色高亮顯示。

此外，文檔註釋只負責描述類（class）、接口（interface）、方法（method）、構造器（constructor）、成員字段（field）。相應地，文檔註釋必須寫在類、接口、方法、構造器、成員字段前面，而寫在其他位置，比如函數內部，是無效的文檔註釋。

文檔註釋採用HTML語法規則書寫，支援HTML標記（tag），同時也有一些額外的輔助標記。需要注意的是，這些標記不是給人看的（通常他們的可讀性也不好），他們的作用是爲了javadoc工具更好地生成最終文檔。所以，雖然有些標記寫起來麻煩且看着不直觀，還是要老老實實按規矩寫滴。

原文地址：網頁連結

/**

* 類

* @author xx

*

*/

public class Hll {

/**

* main方法

* @param args

*/

public static void main(String[] args) {

// new一個新對象

Man m = new Man();

m.name = "張三"；

m.gender = "男"；

m.study(m.name);

}

}

/**

* 接口

* @author xx

*

*/

interface Person {

public int a = 20;

public void study(String s);

}

/**

* 實現Person接口

* @author xx

*

*/

class Man implements Person {

String name;

String gender;

public void study(String s) {

this.name = s;

System.out.print(this.name + "在學習中" + this.gender + "哪裏")；

}

}

public class B {

public static void main(String[] args) {

//定義對象m爲ArrayList類型，長度爲100

ArrayList m = new ArrayList(100);

//循環賦值，第1個元素爲1，第2個元素爲2。，第100個元素爲100

for (int i = 0; i 2) {

//將sy（)方法返回的對象賦值給m

m = sy(m, m.size());

}

//獲得第2個元素賦給n

n = m.get(1);

//輸出

System.out.print(n);

}

public static ArrayList sy(List s, int num) {

//定義對象list爲ArrayList類型

ArrayList list = new ArrayList();

//如果num除以3的餘數不等於0

if (num % 3 != 0) {

//循環的次數爲num除以3的餘數

for (int i = num % 3; i > 0; i--) {

//獲得s中位置爲num-i的元素，添加到list中

list.add(s.get(num - i));

//輸出list

System.out.println(list);

}

}

//循環，條件爲i小於num減去num除以3的餘數

for (int i = 1; i 1) {

for (int i = 0; i