Eclipse 下 javadoc 的使用
阿新 • • 發佈:2019-02-15
Javadoc:用於提取註釋的工具。是jDK安裝的一部分。輸出是HTML檔案。
註釋方法:/** 註釋的內容 */
使用javadoc的兩種方式:
1.嵌入HTMl:
例如:
/**
* <pre>
* 實現.....的功能方法
*</pre>
*/
注意:不要在嵌入的html中使用標題標籤,例如:<h1></h1>,因為javadoc會插入自己的標題,自己新增的標題標籤可能會和它發生衝突
2.使用文件標籤:
例如:
/**
* @authorxiyuan---作者相關資訊
* @deprecated---指出一些舊特性已由新特性所取代,建議使用者不要使用這些舊特性
* @see classname----(引用其他類的文件)
* @since 指定程式程式碼最早使用的版本(java文件中用於指定JDK的版本情況)
* @version version 1.0 ----(版本資訊)
* {@docRoot}----產生到文件根目錄的相對路徑
* {@link}----與@see相似,只是用於行類
*/
還有幾種常用標籤:
@param:用於方法文件,說明引數的意義
@return:用於方法文件,說明返回值含義
3種類型的註釋文件:類註釋、域(變數)註釋、方法註釋。
注意:只能為public、protected成員進行文件註釋
使用方法:
第一步:點選project->Generate javadoc 彈出以下介面
下一步
下一步