Java的帮助文档
使用Javadoc命令生成幫助文檔。
首先定義一個Persion類，在類中定義一個構造方法和一個read()方法。并加入文檔注釋
| /** ?* Title:Persions類<br> ?* Description:通過Persons類來說明Java中的文檔注釋 ?* Company：Zl ?* @author zl ?* @version 1.0 ?* ?*/ public class Persons { public String name; /** ?* 這是Persions類的構造方法 ?* @param name Persions的名字 ?*/ public Persons(String name) { //執行語句 this.name = name; } ? /** ?* 這是read()方法的說明 ?* @param bookName 讀的書的名字 ?* @param time 讀書需要的時間 ?* @return 讀的書的數量 ?*/ public int read(String bookName, int time){ ? return time; } } |
出現的@標記都是有特殊作用的。
| @author | 用于對類的說明 ,表示這個程序 的作者 |
| @version | 用于對類的說明,表示 這個程序的開發版本號 |
| @param | 用于對方法的說明,表示 方法定義 的參數以及參數 對應的說明. |
| @return | 用于對方法的說明,表示方法的返回值代表的意義. |
打開命令行窗口，進入程序的所在目錄，輸入生成文檔的命令。
| Javadoc -d . -version -author Persons.java |
其中：
| -d | 用來指定 輸出文檔存放的目錄 |
| . | 表示 當前的目錄 |
| -version | 用來指定輸出文檔中需包含版本信息 |
| -author | 用來指定輸出文檔中需包含作者信息 |
總結
- 上一篇： maven 解决冲突
- 下一篇： Java弱引用(WeakReferenc