Java 注釋及API文檔(Day4)

注釋

定義 :源文件中用于解釋、說明程序的文字

注釋種類

單行注釋

// 注釋內(nèi)容

多行注釋

/*
注釋文字
……
*/

文檔注釋(Java特有)

/**
@author 指定Java程序作者
@version 指定源文件版本
*/

作用: 文檔注釋內(nèi)容可以被JDK提供的工具 javadoc 解析,生成一套以網(wǎng)頁文檔形式體現(xiàn)的該程序的說明文檔

注釋作用

  • 提升了程序的可讀性
  • 調(diào)試程序的重要方法

單行注釋與多行注釋

  1. 對程序的代碼進行解釋說明
  2. 進行程序調(diào)試

說明:

  1. 單行注釋與多行注釋中聲明的信息不參與編譯,即:編譯后聲明的字節(jié)碼文件中不包含單行注釋和多行注釋中的信息
  2. 多行注釋不能嵌套使用

Java API文檔

  • API: (應(yīng)用程序編程接口)是Java提供的基本編程接口
  • Java語言提供了大量基礎(chǔ)類,因此Oracle也為這些基礎(chǔ)類提供了相應(yīng)的說明文檔,用于向開發(fā)者說明這些類該如何使用以及這些類中包含的方法
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

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

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