首頁 >Java >Java基礎 >jdk工具javadoc的作用是什麼?

jdk工具javadoc的作用是什麼?

青灯夜游
青灯夜游原創
2020-10-28 10:59:105687瀏覽

jdk工具javadoc的作用是「產生Java文件」;javadoc是Java文件產生器,它從程式原始碼中抽取類別、方法、成員等註解形成一個和原始碼配套的API幫助文件。

jdk工具javadoc的作用是什麼?

相關推薦:《Java影片教學

jdk工具javadoc的作用是「生成Java文件".

javadoc是Sun公司提供的技術,它從程式原始碼中抽取類別、方法、成員等註解形成一個和原始碼配套的API幫助文件。也就是說,只要在編寫程式時以一套特定的標籤作註釋,在程式編寫完成後,透過Javadoc就可以同時形成程式的開發文件了。

javadoc指令是用來產生自己API文件的,使用方式:使用指令列在目標文件所在目錄輸入javadoc 檔名.java。

常用標記

標籤 說明 JDK 1.1 doclet #標準doclet 標籤類型
@author 作者 作者識別 #√ 套件、 類別、介面
@version 版本號碼 版本號碼 套件、 類別、介面
@param 參數名稱描述 方法的入參名及描述訊息,如入參有特別要求,可在此註釋。 建構子、方法
#@return 描述 對函數傳回值的註釋 方法
#@deprecated 過期文字 標識隨著程式版本的提升,目前API已經過期,僅為了保證相容性依然存在,以此告之開發者不應再用這個API。 套件、類別、介面、值域、建構子、方法
@throws 例外類別名 建構函式或方法所會拋出的例外。
建構子、方法
@exception 異常類別名稱 同@throws。 建構子、方法
@see 引用 檢視相關內容,如類別、方法、變數等。 套件、類別、介面、值域、建構子、方法
@since 描述文字 API在什麼程式的什麼版本後開發支援。 套件、類別、介面、值域、建構子、方法
{@link套件.類別#成員標籤} 連結到某個特定的成員對應的文檔中。
套件、類別、介面、值域、建構子、方法
{@value } 當常數註解時,如果想將其值包含在文件中,則透過該標籤來引用常數的值。
√(JDK1.4) 靜態值域

此外還有@serial 、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}幾個不常用的標籤,由於不常使用,我們不展開敘述,感興趣的讀者可以查看幫助文檔。

更多程式相關知識,請造訪:程式設計入門! !

以上是jdk工具javadoc的作用是什麼?的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn