Java 注釋語句

Java教程 - Java注釋語句

源代碼中的注釋提供有關(guān)源代碼的信息。這是一個很好的做法是編寫注釋來記錄源代碼

Java中支持三種類型的注釋。

1. 單行
2. 多行
3. 文檔注釋

單行注釋

Java單行注釋從 // 開始，結(jié)束到該行結(jié)束。

public class Main {
  // This is a single line comment.
  public static void main(String[] argv) {
  }

}

多行注釋

Java多行注釋在 /* 和 */ 之間。編譯器忽略從 /* 到 */ 的所有內(nèi)容。

public class Main {
  /* This 
     is 
     a
     Multiline 
     comment.
  */
  public static void main(String[] argv) {
  }

}

Java文檔注釋(Javadoc)

Javadoc文檔注釋用于生成用于記錄程序的HTML文件?？傊覀兺ǔＵ{(diào)用Java文檔評論javadoc。

Javadoc注釋占用一行或多行源代碼。文檔注釋以 /** 開頭，并以 */ 結(jié)尾。從/**到*/的所有內(nèi)容都被編譯器忽略。

以下示例演示Javadoc注釋:

/** 
* Application entry point 
* 
* @param args array of command-line arguments passed to this method 
*/ 
public static void main(String[] args) 
{ 
// TODO code application logic here 
}

此示例從描述main()方法的Javadoc注釋開始。 /** 和 */ 包含方法的描述，其可以包括諸如的HTML標(biāo)簽<p> ，<code> 和 /</code> 和 @param Javadoc標(biāo)記(一個@前綴指令)。

以下列表標(biāo)識幾個常用的標(biāo)簽:

• @author 標(biāo)識源代碼的作者。
• @deprecated 標(biāo)識不應(yīng)再使用的源代碼實體。
• @param 標(biāo)識方法的參數(shù)之一。
• @see 提供了一個see-also參考。
• @since 標(biāo)識實體首次發(fā)起的軟件版本。
• @return 標(biāo)識該方法返回的值的類型。

以下代碼具有更多的文檔注釋

/**
 * A simple class for introducing a Java application.
 * 
 * @author yourName
 */
public class HelloWorld {
  /**
   * Application entry point
   * 
   * @param args
   *          array of command-line arguments passed to this method
   */
  public static void main(String[] args) {
    System.out.println("Hello, world!");
  }
}

我們可以使用JDK的javadoc將這些文檔注釋提取到一組HTML文件中工具，如下:

javadoc 命令默認(rèn)為為公共類和生成基于HTML的文檔公共/受保護(hù)的成員。