Java 的注釋，單行，多行的語法就不在贅述了。

javadoc tags

給 Java 源碼文件書寫注釋，使用常見的 Java 注釋可以實現(xiàn)一些，也可以通過如下的 Javadoc 的 Tags 來實現(xiàn)一些特殊的比如跳轉(zhuǎn)，參數(shù)返回值等特殊標(biāo)記。

javadoc 標(biāo)記有如下一些：

@author 作者名，一般不推薦使用，git blame 基本上能夠找到每一行代碼的作者

@version 版本號

@see 跳轉(zhuǎn)到相關(guān)類或者主題

@param 對方法中某參數(shù)的說明

@return 對方法返回值的說明

@exception 對方法可能拋出的異常進(jìn)行說明

不過已經(jīng)不建議在 Java 源文件中使用 @author 標(biāo)記，現(xiàn)代的 git 完全能夠滿足模塊作者的追溯，甚至可以精確到每一行的作者。

Package doc

上面的方法可以給類，方法，參數(shù)等等編寫注釋，如果要給一個包添加注釋，就需要額外添加 package-info.java 的文件。

從 Java 1.5 版本開始可以在包下新建一個名為 package-info.java 的文件，在這個文件中可以使用標(biāo)準(zhǔn) Java 注釋來給 package 書寫文檔：

com/foo/package-info.java:

/**

* com.foo is a group of bar utils for operating on foo things.

*/

package com.foo;

//rest of the file is empty

注釋中的代碼

如果要在 javadoc 中書寫代碼，尤其是想要展示一些例子的時候，不可避免的會用到 以及 @ 等等特殊的符號。Javadoc 默認(rèn)是 html 的 tag 來渲染格式，所以這種情況下有

和 選擇，然后 javadoc 還提供了 {@code} 語法。這三個方式都可以用來注釋代碼，但各自又不相同。

使用 pre 標(biāo)簽

標(biāo)記是 html 默認(rèn)的格式化標(biāo)簽，如果使用 標(biāo)簽，那么所有的 html 的標(biāo)記都需要轉(zhuǎn)義。

/**

*

* public class JavadocTest {

* // indentation and line breaks are kept

*

* @SuppressWarnings

* public List<String> generics(){

* // '@', '' have to be escaped with HTML codes

* // when used in annotations or generics

* }

* }

*

*/

public class PreTest {}

命令行的使用

Java 安裝完成之后在 Java Path 的目錄中自帶了 javadoc 這個命令行，如果不想使用 maven-javadoc-plugin 可以使用這個命令來生成 javadoc.

用法：

javadoc [options] [packagenames] [sourcefiles]

選項：

-public 僅顯示 public 類和成員

-protected 顯示 protected/public 類和成員 (缺省)

-package 顯示 package/protected/public 類和成員

-private 顯示所有類和成員

-d 輸出文件的目標(biāo)目錄

-version 包含 @version 段

-author 包含 @author 段

-splitindex 將索引分為每個字母對應(yīng)一個文件

-windowtitle 文檔的瀏覽器窗口標(biāo)題

在 Intellij 中調(diào)整文件頭

Intellij 默認(rèn)會在創(chuàng)建文件的時候給文件添加一些注釋，這些注釋可以在如下的設(shè)置中修改：

File -> Setting -> Editor-> File and Code Template-> File Header

總結(jié)

以上是生活随笔為你收集整理的java java.doc_使用 javadoc 自动生成 Java 文档的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。