簡介
Javadoc用于描述類或者方法的作用。Javadoc可以寫在類上面和方法上面。
用于注釋類
寫在類上注釋可以分為三段：
第一段:概要描述，一句話說明類的作用，以
開頭以“.”結尾。
@link：{@link 包名.類名#方法名(參數類型)}用于快速連結到相關代碼。
示例
public abstract class StringUtils {
}
@code： {@code text} 将文本标記為code。
// 完全限定的類名
{@link java.lang.Character}
// 省略包名
{@link String}
// 省略類名，表示指向目前的某個方法
{@link #length()}
// 包名.類名.方法名(參數類型)
{@link java.lang.String#charAt(int)}
第二段:較長的描述，較長的描述類的作用，可以寫多段，都是以
開頭，以“.”結尾。其中可以添加對類的使用方法的示例，示例使用
包括起來。
@param：一般類中支援泛型時會通過@param來解釋泛型的類型。
public interface List extends Collection {}
第三段，文檔标注，用于@author标注作者，@since标注文檔的起始版本号，@version目前版本号，等等。
完整示例:
image
代碼：
/**
* 類{@code CoidsDataSource}初始化codis連接配接池
*
*
建立一個codis連接配接池
*
* 使用方法
* @Autowired
* private JedisResourcePool jedisResourcePool;
* 擷取一個jedis連接配接
* Jedis jedis = jedisResourcePool.getResource();
* 回收jedis連接配接
* jedis.close();
*
*
*
* @author Alex Han
* @since 1.0
* @version 1.2
*
*/
public class CoidsDataSource {}
用于注釋方法
第一段：概要描述，通常用一句或者一段話簡要描述該方法的作用，以“.”結尾。
第二段：較長的描述，通常用多段話較長的描述方法的作用、使用方法等，以“.”結尾。
第三段：文檔标注，@param标注參數，@return标注傳回值，@exception标注解異常，@see标注另請參閱。
完整示例：
image
代碼:
@ApiOperation(value ="初始化自己的資産",httpMethod = "POST")
@PostMapping("/init/selfDevice")
public ResultData initJedisSelfDevice(String setName,String array){
JSONArray jsonArray = JSONArray.parseArray(array);
Jedis jedis = jedisResourcePool.getResource();
for(int i = 0 ; i < jsonArray.size() ; i ++){
jedis.sadd(setName,jsonArray.get(i).toString());
}
jedis.close();
return new ResultData<>(null, ResultStatus.initStatus(StatusEnum.SUCCESS));
}
使用IDEA生成Java doc
點選菜單Tools->Generate Javadoc,進行以下操作：
image
點選ok，生成的文檔頁面會在浏覽器自動打開，同時在配置的目錄也生成了文檔。
生成的文檔：
image
image
選擇一個類,格式如下:
image
方法格式如下:
image
使用maven-javadoc-plugin生成javadoc.jar
在maven pom中配置：
org.apache.maven.plugins
maven-javadoc-plugin
2.10.2
true
attach-javadocs
jar
使用mvn package指令打包。生成的javadoc.jar。
image