註釋及標記

一：常用註釋

//單行註釋； ---->一般用於描述單行的資訊

/**

*/多行註釋；---->一般使用者描述類或方法

二：嵌入HTML

註釋中嵌入HTML為了使後面生成api更加美觀。在/**與*/中間可以根據HTML語言任意設計api介面。以描述程式碼片段的資訊。

/**
 * <p>
 * System.out.println(new Date()); 
 * </p>
 * <li></li>
 */

三：引用其他類

@see所有文件型別都可以包含此標記，他允許我們引用其他類裡的文件，對於這個標記javadoc會生成響應的HTML，將其連線到其他文件。

@see 類名

@see 完整類名

@sess完整類名#方法名

四：類文件標記

[email protected] 版本資訊；若在javadoc中使用了“-version”標記，就會生成HTML文件裡提取出的版本資訊。

[email protected] 作者資訊；若在javadoc中使用了“-author”標記，就會生成HTML文件裡提取出的作者資訊。

五：變數文件標記

變數文件只能包括HTML以及@see引用

1. 方法文件標記

[email protected] 引數名

[email protected] 返回值的含義

[email protected]