Intellij IDEA如何生成JavaDoc？

發(fā)布時(shí)間：2020-07-06 22:51:28 來(lái)源：網(wǎng)絡(luò) 閱讀：9826 作者：武哥_話神欄目：開發(fā)技術(shù)

javadoc基本介紹

javadoc是Sun公司提供的一個(gè)技術(shù)，它從程序源代碼中抽取類、方法、成員等注釋形成一個(gè)和源代碼配套的API幫助文檔。也就是說(shuō)，只要在編寫程序時(shí)以一套特定的標(biāo)簽作注釋，在程序編寫完成后，通過(guò)Javadoc就可以同時(shí)形成程序的開發(fā)文檔了。

javadoc命令是用來(lái)生成自己API文檔的，使用方式：使用命令行在目標(biāo)文件所在目錄輸入javadoc +文件名.java。

javadoc常用標(biāo)識(shí)

標(biāo)簽	說(shuō)明	JDK 1.1 doclet	標(biāo)準(zhǔn)doclet	標(biāo)簽類型
@author 作者	作者標(biāo)識(shí)	√	√	包、類、接口
@version 版本號(hào)	版本號(hào)	√	√	包、類、接口
@param 參數(shù)名描述	方法的入?yún)⒚懊枋鲂畔ⅲ缛雲(yún)⒂刑貏e要求，可在此注釋。	√	√	構(gòu)造函數(shù)、方法
@return 描述	對(duì)函數(shù)返回值的注釋	√	√	方法
@deprecated 過(guò)期文本	標(biāo)識(shí)隨著程序版本的提升，當(dāng)前API已經(jīng)過(guò)期，僅為了保證兼容性依然存在，以此告之開發(fā)者不應(yīng)再用這個(gè)API。	√	√	包、類、接口、值域、構(gòu)造函數(shù)、方法
@throws異常類名	構(gòu)造函數(shù)或方法所會(huì)拋出的異常。		√	構(gòu)造函數(shù)、方法
@exception 異常類名	同@throws。	√	√	構(gòu)造函數(shù)、方法
@see 引用	查看相關(guān)內(nèi)容，如類、方法、變量等。	√	√	包、類、接口、值域、構(gòu)造函數(shù)、方法
@since 描述文本	API在什么程序的什么版本后開發(fā)支持。	√	√	包、類、接口、值域、構(gòu)造函數(shù)、方法
{@link包.類#成員標(biāo)簽}	鏈接到某個(gè)特定的成員對(duì)應(yīng)的文檔中。		√	包、類、接口、值域、構(gòu)造函數(shù)、方法
{@value}	當(dāng)對(duì)常量進(jìn)行注釋時(shí)，如果想將其值包含在文檔中，則通過(guò)該標(biāo)簽來(lái)引用常量的值。		√(JDK1.4)	靜態(tài)值域

此外還有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}幾個(gè)不常用的標(biāo)簽，由于不常使用，我們展開敘述，感興趣的讀者可以查看幫助文檔。

那我們?nèi)绾瓮ㄟ^(guò)Intellij IDEA如何生成JavaDoc？

第一步：在工具欄中找到 Tool，然后再子菜單中找到 Generate JavaDoc。

Intellij IDEA如何生成JavaDoc？

第二步：在生成文檔上進(jìn)行配置。

配置的簡(jiǎn)單介紹：

Intellij IDEA如何生成JavaDoc？

參數(shù)說(shuō)明

1.Whole project:整個(gè)項(xiàng)目都生成文檔 2.Custom scope 自定義范圍。如下：（1）project files 項(xiàng)目文件，（2）project production files 項(xiàng)目產(chǎn)品文件，（3）project test files 項(xiàng)目的測(cè)試文件，未知范圍，class hierarchy 類層 3.include test source 包含測(cè)試目錄 4.include JDK and … 包含jdk和其他的第三方j(luò)ar 5.link to JDK documentation…鏈接到JDK api 6.output directy 生成的文檔存放的位置（1）private、package、protected、public 生成文檔的級(jí)別（類和方法）（2）右邊的Generate…是選擇生成的文檔包含的內(nèi)容，層級(jí)樹、導(dǎo)航、索引.. （3）再右邊是生成的文檔包含的內(nèi)容信息，作者版本等信息 7.Locale 語(yǔ)言類型,zh-CN 8.Other command line arguments 其他參數(shù) 9.Maximum heep… 最大堆棧

1.Whole project:整個(gè)項(xiàng)目都生成文檔

2.Custom scope 自定義范圍。如下：

（1）project files 項(xiàng)目文件，

（2）project production files 項(xiàng)目產(chǎn)品文件，

（3）project test files 項(xiàng)目的測(cè)試文件，未知范圍，class hierarchy 類層

3.include test source 包含測(cè)試目錄

4.include JDK and … 包含jdk和其他的第三方jar

5.link to JDK documentation…鏈接到JDK api

6.output directy 生成的文檔存放的位置

（1）private、package、protected、public 生成文檔的級(jí)別（類和方法）

（2）右邊的Generate…是選擇生成的文檔包含的內(nèi)容，層級(jí)樹、導(dǎo)航、索引..

（3）再右邊是生成的文檔包含的內(nèi)容信息，作者版本等信息

7.Locale 語(yǔ)言類型,zh-CN

8.Other command line arguments 其他參數(shù)

9.Maximum heep… 最大堆棧

我這里的配置如下：

Intellij IDEA如何生成JavaDoc？

說(shuō)明：IntelliJ IDEA作為Java流行的編輯器, 其生成一些Javadoc會(huì)對(duì)中文亂碼, 使用UTF-8編碼即可. 這個(gè)常見的問題, 則需要生成時(shí)設(shè)置參數(shù)即可.

在 “Tools->Gerenate JavaDoc” 面版的 “Other command line arguments:” 欄里輸入：

-encoding utf-8 -charset utf-8

1	-encoding utf-8 -charset utf-8

不然的話會(huì)報(bào)可能會(huì)報(bào)錯(cuò)誤: 編碼GBK的不可映射字符。

向AI問一下細(xì)節(jié)

Intellij IDEA如何生成JavaDoc？

javadoc基本介紹

javadoc常用標(biāo)識(shí)

第一步：在工具欄中找到 Tool，然后再子菜單中找到 Generate JavaDoc。

第二步：在生成文檔上進(jìn)行配置。

猜你喜歡

最新資訊

相關(guān)推薦

相關(guān)標(biāo)簽

第一步：在工具欄中找到 Tool，然后再子菜單中找到 Generate JavaDoc。