編寫註釋的原因
編寫程序時總需要爲程序添加一些註釋，用以說明某段代碼的作用，或者說明某個類的用途、某個方法的功能，以及該方法的參數和返回值的數據類型及意義等。
編寫註釋的原因及意義如下
1、爲了更好的閱讀自己編寫的代碼，建議添加這注釋。自己寫的代碼，可能過一段時間回顧的時候，就變得不熟悉。這個時候，註釋就起到了很好的幫助作用。
2、可讀性第一，效率第二。一個軟件一般都是一個團隊協同作戰開發出來的。因此，一個人寫的代碼，需要被整個團隊的其他人所理解。
3、代碼即文檔。程序源代碼是程序文檔的重要組成部分。
註釋的語法規則
編寫Java中的註釋不會出現在可執行程序中。因此，可以在源程序中根據需要添加任意多的註釋，而不必擔心可執行代碼會膨脹。在 Java 中，有三種書寫註釋的方式。
1、單行註釋
2、多行註釋
3、文檔註釋
下面分別詳細的介紹這三種註釋。
單行註釋：是最常用的註釋方式，其註釋內容從 "//"開始到本行末尾。
// 作者：louis.
// 日期：08/26.
// 類名：FirstSample.
// 作用：一個簡單的 Java 應用程序.
public class FirstSample
{
// main 方法，Java 應用程序的入口
public static void main(String[] args)
{
// 向控制檯輸出語句 "Hei,Hei".
System.out.println("Hei,Hei");
// 下面這句代碼被註釋掉了，不會執行！
// System.out.println("Hei,Hei! Again.");
}
}// FirstSample 類的所有成分都應該定義在 FirstSample 類的一對大括號（"{}"）內.
多行註釋：註釋內容放到 "/*" 和 "*/"之間。也即是，註釋從 "/*" 開始，到 "*/" 結束。
/* 作用：louis. */
/* 日期：08/26. */
/* 類名：FirstSample.
作用：一個簡單的 Java 應用程序. */
public class FirstSample
{
/* 可以註釋一行內容 */
/* main 方法，Java 應用程序的入口 */
public static void main(String[] args)
{
System.out.println("Hei,Hei");
/* 也可以註釋多行內容 */
/*
System.out.println("不知道說什麼了，舉什麼例子好呢？");
System.out.println("Hei,Hei! Again.");
*/
}
}
tips：需要注意的是，多行註釋 "/*"、"*/" 不可以嵌套。
如果多行註釋進行了嵌套，會發生什麼呢？
public class FirstSample
{
public static void main(String[] args)
{
System.out.println("Hei,Hei");
// 下面演示多行註釋進行嵌套
/*
System.out.println("不知道說什麼了，舉什麼例子好呢？");
/* System.out.println("Hei,Hei! Again."); */
*/
}
}
編譯這段代碼後，編譯結果如下，
編譯錯誤，因爲在多行註釋 "/*"、"*/" 中嵌入了多行註釋，那麼第一個多行註釋的 "/*" 就會和第二個多行註釋的 "*/" 相匹配。第二個多行註釋的 "/*" 被當做了註釋的一部分，第一個多行註釋的 "*/" 變成了多餘的符號，所以第11行代碼出錯。
文檔註釋：Java 語言提供了專門用於生成文檔的註釋。
文檔註釋是以 "/**" 開始，以 "*/"結束的。
/**
* This is a simple class.
* @author louis
* @version 1.0
*/
public class FirstSample
{
/**
* main function,the entrance of Java Application.
* @param args command line arguments.
*/
public static void main(String[] args)
{
System.out.println("Hei,Hei");
}
}
本文的代碼是存放在 "louis" 文件夾下的，下面是生成文檔之前的文件夾信息，已有一個 Java 源程序文件。
下面使用 JDK 中的 javadoc 命令，來生成 Java 的 API 文檔，命令是：
javadoc
本文這裏使用簡單的 javadoc 命令，
javadoc -d docs FirstSample.java
在 "FirstSample.java" 所在文件夾中新建一個文件夾 "docs"，存放生成的文檔文件。
如果運行後，沒有錯誤，那麼就生成了正確的文檔。
打開 "FirstSample.java" 所在的文件夾 "louis"，在它裏面有一個 "docs" 的新文件夾生成，
可以打開這個文件夾，看看裏面都有什麼文件。
我們只關心這個名爲 "index.html" 的文件，使用瀏覽器打開它。
可以看到如下的信息：
這裏，註釋的信息比較少，所以文檔的信息也比較少。
可以將這個 html 文檔大致分爲5個部分。
第一部分：類的導航部分；
第二部分：快速切換瀏覽信息的部分；
第三部分：當前類的信息大致介紹；
第四部分：當前類的方法的概要介紹；
第五部分：當前類的方法的詳細介紹。
讀者可以自己多添加註釋嘗試一下。
Over！