java doc

Javadoc 是當初 Sun 在發表 Java 時，連帶發表的文件產生工具，只要依照其特定的格式在開發程式碼的同時撰寫註解 (documentation comment)，就能為我們直接由原始碼產生有用的 API 說明文件。

詳細的一些使用規範可以參考How to Write Doc Comments for the Javadoc Tool。

範例



/**
* method 摘要。(以一句話說明完此 method 的作用，最後加個句點)
* method 詳細資訊，提示說在什麼情況下該用這個 method，而且應該帶什麼參數進來；又在使用情況下不該用。
* 可以輸入多行，也可以使用類似 HTML 的語法，例如<code>System.out</code>,<ul><li>...</li></ul>...。
*
* @param parameter
* 參數說明。 (可不可以為 null 之類的描述 (用 @NotNull 更好))
* @return 詳細的回傳結果說明。 (一般我們是不希望有 method 會回傳 null，很多情況下丟 Exception 更好)
* @throws XxxException
* 代表發生 XXX 狀況。
* @throws YyyException
* 代表發生 YYY 狀況。
*/
public ReturnType performSomething(ParameterType parameter)
throws XxxException, YyyException {
// ...
}