文檔說明
1、文檔概述：主要是描述Java javadoc 標(biāo)準(zhǔn)以及注釋規(guī)范
2隘冲、參考地址：https://blog.csdn.net/linton1/article/details/93733508
基本定義
Javadoc是Sun公司提供的一個(gè)技術(shù)钳吟，從程序源代碼中抽取類坤按、方法考传、成員等注釋形成一個(gè)和源代碼配套的API幫助文檔
使用方式
javadoc 源文件名.java
javadoc -d 文檔存放目錄 源文件名.java
通過IDEA生成Javadoc ： Tools -> Generate JavaDoc
基本標(biāo)簽
| 標(biāo)簽 | 說明 |
|---|---|
| @author | 作者標(biāo)識(shí) |
| @version | 版本號 |
| @return | 對函數(shù)返回值的描述 |
| @deprecated | 標(biāo)識(shí)過期API（為了保證兼容性招拙，仍可用其屏，但不推薦用） |
| @throws | 構(gòu)造函數(shù)或方法會(huì)拋出的異常 |
| @exception | 同@throws |
| @see | 引用喇勋，查看相關(guān)的內(nèi)容，如類偎行，方法川背，變量等，必須頂頭寫 |
| {@link 包.類#成員} | 引用蛤袒，同@see熄云，但可寫在任意位置 |
| {@value} | 對常量注釋，如果其值包含在文檔中妙真，通過改標(biāo)簽引用常量的值 |
| {@code}} | {@code text}將文本標(biāo)記為code缴允，會(huì)被解析成text} ,在Javadoc成只要涉及到類名或者方法名，都需要使用@code進(jìn)行標(biāo)記 |
| @param | 說明方法的參數(shù) |
| @inheritDoc | 用于繼承父類中的Javadoc珍德，父類的文檔注釋练般，被繼承到了子類 |
注釋規(guī)范
// 注釋一行
/ * */ 注釋若干行
/** ……*/ 注釋若干行，寫入Javadoc文檔
文檔格式
第一段：概要描述锈候，通常用一句話或者一段話簡要描述該類的作用薄料，以英文句號結(jié)束
第二段：詳細(xì)描述，通常用一段或者多段話來詳細(xì)描述該類的作用泵琳，一般每段話都以英文句號作為結(jié)束
第三段：文檔標(biāo)注摄职，用于標(biāo)注作者誊役，創(chuàng)建時(shí)間，參閱類等信息
如：
生成文檔是HTML格式谷市。
換行<br>
分段<p>(寫在段前）)
基本示例
/**
* show 方法的簡述.
* <p>show 方法的詳細(xì)說明第一行<br>
* show 方法的詳細(xì)說明第二行
* @param b true 表示顯示势木，false 表示隱藏
* @return 沒有返回值
*/
public void show(boolean b) {
}
Eclipse 生成API 文檔
1、打開Eclipse ->Project->Generate Javadoc
2歌懒、選擇對應(yīng)的項(xiàng)目
3啦桌、Next
4、編寫Document title
5及皂、Next
6甫男、VM options 設(shè)置：-encoding UTF-8 -charset UTF-8
7、Finish!