文檔注釋與API文檔

文檔注釋（Java特有）

格式:
/**
  @author 指定java程序的作者
  @version 指定源文件的版本
*/
比較:
  • 單行和多行注釋
    注釋內(nèi)容不會參與編譯，進而不會出現(xiàn)在.class字節(jié)碼文件中，不會被JVM（java虛擬機）解釋執(zhí)行。
    作用: 增加程序的可讀性；協(xié)助調(diào)試程序；
    備注: 多個多行注釋不可嵌套使用
  • 文檔注釋
    注釋內(nèi)容可以被JDK提供的工具 javadoc 所解析，生成一套以網(wǎng)頁文件形式體現(xiàn)的該程序的說明文檔。
    操作方式：
    命令行窗口定位到HelloWorld.java所在目錄，執(zhí)行以下命令，在該目錄下生成一個叫mydoc的文件夾，里面的index.html即為該類的說明文檔。

javadoc -d mydoc -author -version HelloWorld.java

正確的注釋和注釋風格
  • 使用文檔注釋來注釋整個類或整個方法
  • 使用單行或多行注釋來注釋方法中的某一個步驟

Java的API文檔

API （Application Programming Interface,應用程序編程接口）是 Java 提供的基本編程接口。Java語言提供了大量的基礎類，因此 Oracle 也為這些基礎類提供了相應的API文檔，用于告訴開發(fā)者如何使用這些類，以及這些類里包含的方法。這些API文檔就是通過文檔注釋生成的。
下載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è):詳細說明區(qū)）

API文檔.png

?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容