單行註釋和多行註釋
1.用於說明某個類的用途、某個方法的功能，以及該方法的參數和返回值的數據類型及意義等。
2.用於調試程序，註釋掉可能有錯誤的代碼或打印信息看程序執行到哪裏出錯了。
單行註釋 //
多行註釋 /* 和 */
CommentTest.java
public class CommentTest {
/*
* 多行註釋
*/
public static void main(String args[]) {
// 單行註釋
System.out.println("Hello World");
// System.out.println("這行代碼被註釋了、將不會被編譯、執行！");
}
}文檔註釋
用於生成API說明文檔，告訴別人每個類、每個方法的功能及用法。
文檔註釋 /** 和 */
/**
* 類文檔註釋
*
* @author liweidong
*
* */
public class Javadoc {
/**
* 屬性文檔註釋
*/
protected String name;
/**
* 主方法，程序的入口
*/
public static void main(String[] args) {
System.out.println("hello world");
}
}IDE工具生成文檔實際上是使用了javadoc命令。
javadoc命令默認只處理public或protected修飾的內容。
javadoc標記：
@author:指定java程序的作者。
@version:指定源文件的版本
@deprecated：不推薦使用的方法。
@param:方法的參數說明信息。
@return:方法的返回值說明信息。
@see:"參見"，用於指定交叉參考的內容。
@exception:拋出異常的類型。
@throws:拋出的異常，和exception同義。
標記的位置限制
在類或接口可以出現的有:@see @deprecated @author @version
方法或構造器:@see @deprecated @param @return @throws @exception
Field文檔註釋中:@see @deprecated