java中的注釋分為三種
- 單行注釋
// 這是單行注釋的內(nèi)容，以 // 開頭
- 多行注釋
/*
這是多行注釋，
*/
- 文檔注釋
/**
* @author yichang
* @version 1.0.0
*/
文檔注釋，會被編譯，單行和多行注釋不會被編譯
package com.yichang.java.comment;
/**
* @author yichang
* @version 1.0.0
*/
public class JavaComment {
/**
* 這是main方法，程序的入口
* @param args
*/
public static void main(String [] args) {
// 下面是輸出語句
System.out.println("java注釋用法");
/*
這是
多行
注釋
*/
}
}
例如這個文件。在當(dāng)前JavaComment.java目錄下輸入
javadoc JavaComment.java
// 或者。指定輸出的目錄
javadoc JavaComment.java 目錄
java程序就會自動幫你輸出doc文檔
圖片.png
編譯完成之后。在當(dāng)前JavaComment.java文件的根目錄下就會生成很多文件。
如下圖：
圖片.png
打開index.html。就可以查找文檔的內(nèi)容了。
附上doc的標簽
| 標簽 | 描述 | 示例 |
|---|---|---|
| @author | 標識一個類的作者 | @author yichang |
| @deprecated | 指名一個過期的類或成員 | @deprecated 這是一個過時的方法 |
| @exception | 標志一個類拋出的異常 | @exception 此方法可能會出現(xiàn)IO異常 |
| {@inheritDoc} | 從直接父類繼承的注釋 | Inherits a comment from the immediate surperclass. |
| {@link} | 插入一個到另一個主題的鏈 | {@link name text} |
| {@linkplain} | 插入一個到另一個主題的鏈接，但是該鏈接顯示純文本字體 | Inserts an in-line link to another topic. |
| @param | 說明一個方法的參數(shù) | @param parameter-name explanation |
| @return | 說明返回值類型 | @return explanation |
| @see | 指定一個到另一個主題的鏈接 | @see anchor |
| @serial | 說明一個序列化屬性 | @serial description |
| @serialData | 說明通過writeObject( ) 和 writeExternal( )方法寫的數(shù)據(jù) | @serialData description |
| @serialField | 說明一個ObjectStreamField組件 | @serialField name type description |
| @since | 標記當(dāng)引入一個特定的變化時 | @since release |
| @throws | 和 @exception標簽一樣. | The @throws tag has the same meaning as the @exception tag. |
| {@value} | 顯示常量的值，該常量必須是static屬性。 | Displays the value of a constant, which must be a static field. |
| @version | 指定類的版本 | @version info |
