文檔注釋（Java特有）
格式:
/**
@author 指定java程序的作者
@version 指定源文件的版本
*/
比較:
-
單行和多行注釋
注釋內(nèi)容不會(huì)參與編譯挟冠，進(jìn)而不會(huì)出現(xiàn)在.class字節(jié)碼文件中仲墨，不會(huì)被JVM（java虛擬機(jī)）解釋執(zhí)行。
作用: 增加程序的可讀性；協(xié)助調(diào)試程序；
備注: 多個(gè)多行注釋不可嵌套使用 -
文檔注釋
注釋內(nèi)容可以被JDK提供的工具 javadoc 所解析古沥，生成一套以網(wǎng)頁(yè)文件形式體現(xiàn)的該程序的說(shuō)明文檔。
操作方式：
命令行窗口定位到HelloWorld.java所在目錄娇跟，執(zhí)行以下命令岩齿，在該目錄下生成一個(gè)叫mydoc的文件夾，里面的index.html即為該類的說(shuō)明文檔逞频。
javadoc -d mydoc -author -version HelloWorld.java
正確的注釋和注釋風(fēng)格
- 使用文檔注釋來(lái)注釋整個(gè)類或整個(gè)方法
- 使用單行或多行注釋來(lái)注釋方法中的某一個(gè)步驟
Java的API文檔
API （Application Programming Interface,應(yīng)用程序編程接口）是 Java 提供的基本編程接口纯衍。Java語(yǔ)言提供了大量的基礎(chǔ)類，因此 Oracle 也為這些基礎(chǔ)類提供了相應(yīng)的API文檔苗胀，用于告訴開發(fā)者如何使用這些類，以及這些類里包含的方法瓦堵。這些API文檔就是通過(guò)文檔注釋生成的基协。
下載API:
下載地址:https://www.oracle.com/java/technologies/javase-downloads.html
-->Java SE 8u241-->Documentation Download-->下載jdk-8u241-docs-all.zip-->docs-->api-->index.html-->如下圖（左上角:包列表區(qū)； 左下角:類列表區(qū)菇用； 右側(cè):詳細(xì)說(shuō)明區(qū)）
API文檔.png
