java類注釋,java 註解類

本文目錄一覽：

• 1、Java注釋有幾種類型
• 2、如何寫Java文檔注釋
• 3、java 中的幾種注釋方式
• 4、簡述JAVA程序中注釋的作用及類型。
• 5、java中的注釋可分為三種類型
• 6、java 文檔注釋是注釋什麼的,不是有多行注釋了嗎?

Java注釋有幾種類型

三種類型：

1、單選注釋：符號是：//

2、塊注釋： 符號是： /* */ 可以跨多行

3、javadoc注釋： 符號是： /** */ 可以跨多行， 生成javadoc時，這樣的注釋會被生成標準的javaapi注釋。

如何寫Java文檔注釋

如何寫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工具更好地生成最終文檔。所以，雖然有些標記寫起來麻煩且看着不直觀，還是要老老實實按規矩寫滴。

原文地址：網頁鏈接

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注釋我們主要了解三種：

1,　// 注釋一行 　

2,　/* …… */ 注釋若干行

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

java圖標通常這種注釋的多行寫法如下： /** * ……… * ……… */

Java：

Java是一門面向對象編程語言，不僅吸收了C++語言的各種優點，還摒棄了C++里難以理解的多繼承、指針等概念，因此Java語言具有功能強大和簡單易用兩個特徵。Java語言作為靜態面向對象編程語言的代表，極好地實現了面向對象理論，允許程序員以優雅的思維方式進行複雜的編程 。

Java具有簡單性、面向對象、分布式、健壯性、安全性、平台獨立與可移植性、多線程、動態性等特點 。Java可以編寫桌面應用程序、Web應用程序、分布式系統和嵌入式系統應用程序等。

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

Java中三種類型的注釋：

單行注釋：// 注釋內容

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

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

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

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

擴展資料：

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

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

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

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

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

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

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

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

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

擴展資料

java常用的文檔注釋標籤

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

實例： @author description

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

實例： @deprecated description

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

實例：@exception exception-name explanation

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

實例：Inherits a comment from the immediate surperclass.

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

實例：{@link name text}

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

實例：Inserts an in-line link to another topic.

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

實例：@param parameter-name explanation

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

實例：@return explanation

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

實例：@see anchor

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

實例：@serial description

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