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

• <spanstyle="font-size:18px;">*/

• /**javadoc注釋的內容

• */

• publicclassHello{

• /**屬性上的注釋*/

• publicStringname;

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

• *@paramargs用戶輸入參數

• */

• publicstaticvoidmain(String[]args){

• System.out.println("HelloWorld!");

• f1();

• }

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

• publicstaticvoidf1(){

• System.out.println("f1()！");

• }

• }</span>

[java]view plain

• <spanstyle="font-size:18px;">importjava.io.IOException;

• /**javadoc注釋內容

• *@since1.0

• *@version1.1

• *@authorBlueJey

• *<br>鏈接到另一個文檔{@linkHello},就這些

• *seeHello

• */

• publicclassHelloWorld{

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

• publicStringname;

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

• *@paramargs用戶輸入的參數，是數組

• *@throwsIOExceptionmain方法io異常

• */

• publicstaticvoidmain(Stringargs[])throwsIOException{

• System.out.println("helloWorld!");

• f1();

• f2(1);

• }

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

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

• */

• publicstaticvoidf1(){

• System.out.println("fl()!");

• }

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

• *@return返回是否OK

• *@parami輸入參數i

• *@seeHello

• *@throwsIOExceptionio異常

• */

• publicstaticStringf2(inti)throwsIOException{

• System.out.println("f1()!");

• return"OK";

• }

• }</span>

注意：

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

javadoc-version-author-ddoc*.java

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

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

（1）單行注釋：以「 // 」開頭後面接所要加的說明的內容。如下面所示： //定義變數a int a = 10; //定義變數b int b = 20;上面的語句中，在編譯的過程就會直接略過注釋，只會編譯 int a = 10 和 int b = 20這兩句。由此可見注釋只是起著說明的作用。
（2）多行注釋：以「/*」開頭，以「*/」結尾。 假設當你要說明你所寫的代碼的功能時。要說明的內容有很多。如果全部放在同一行會顯得很難看。所以一般會用多行來寫，如下所示// 說明//說明//說明//說明以上是用四個單行注釋來注釋四行說明。但如果有10行說明就要按十個「//」這顯示很麻煩，所以這時就可採用多行注釋。上面的可改成：/*說明說明說明說明*/也可以這樣/* 說明 說明 說明 說明 */
（3）文檔注釋：以「/**」開頭，以「*/」結尾。文檔注釋主要是生成文檔的。

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

Java中三種類型的注釋：

單行注釋：// 注釋內容

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

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

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

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

(3)java程序注釋擴展閱讀：

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