資訊專欄INFORMATION COLUMN
摘要：概述只有種注釋方式。單行注釋塊注釋說明注釋，等說明注釋允許你在程序中嵌入關(guān)于程序的信息。每一個標簽必須在一個新行的開始。多個相同類型的標簽應(yīng)該放成一組。類描述輸出工具將你程序的源代碼作為輸入，輸出一些包含你程序注釋的文件。參考資料文檔注釋
概述
Java只有3種注釋方式。
//,單行注釋
/* */,塊注釋
說明注釋，@author,@version等
說明注釋允許你在程序中嵌入關(guān)于程序的信息。你可以使用javadoc工具軟件來生成信息，并輸出到HTML文件中。
Javadoc 標簽javadoc工具軟件識別以下標簽
| 標簽 | 描述 |
|---|---|
| @author | 標示一個類的作者 |
| @deprecated | 標識一個過期的類或成員 |
| {@docRoot} | 指明當(dāng)前文檔跟目錄的路徑 |
| @exception | 指明一個類拋出的異常 |
| @throws | 和@exception一樣 |
| {@inheritDoc} | 從直接父類繼承的注釋 |
| {@link} | 插入一個到另一個主題的鏈接 |
| {@linkplain} | 插入一個到另一個主題的鏈接，但該鏈接顯示純文本字體 |
| @param | 說明一個方法的參數(shù) |
| @return | 說明返回值類型 |
| @see | 指定一個到另一個主題的鏈接 |
| @serial | 說明一個序列化屬性 |
| @serialData | 說明通過 writeObject() 和 writeExternal() 方法寫的數(shù)據(jù) |
| @serialField | 說明一個ObjectStreamField組件 |
| @since | 標記當(dāng)引入一個特定的變化時 |
| {@value} | 顯示常亮的值，必須是static屬性 |
| @version | 指定類的版本號 |
在開始的/**之后，第一行或幾行是關(guān)于類、變量和方法的主要描述。
之后，你可以包一個或多個各種各樣的@標簽。每一個@標簽必須在一個新行的開始。
多個相同類型的標簽應(yīng)該放成一組。例如，如果你有三個@see標簽，可以將它們一個接一個的放在一起。
/** * 類描述 * @author panda * @version 1.2 */ ...Javadoc 輸出
Javadoc 工具將你Java程序的源代碼作為輸入，輸出一些包含你程序注釋的HTML文件。
每一個類的信息將在獨自的HTML文件里。Javadoc也可以輸出繼承的樹形結(jié)構(gòu)和索引。
由于Javadoc的實現(xiàn)不同，工作也可能不同，你需要檢查你的Java開發(fā)系統(tǒng)的版本等細節(jié)，選擇合適的Javadoc版本。
實例
package com.coder4j.jse.javadoc;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
/**
* 輸入一個數(shù)，輸出其平方數(shù)。
*
* @author panda
* @version 1.2
*/
public class SquareNum {
/**
* 輸出平方值。
*
* @param num
* 待求平方數(shù)
* @return 平方值
*/
public double square(double num) {
return num * num;
}
/**
* 用戶輸入一個數(shù)
*
* @return 返回用戶輸入的數(shù)
* @exception IOException
* 可能拋出的異常
* @see IOException
*/
public double getNumber() throws IOException {
InputStreamReader isr = new InputStreamReader(System.in);
BufferedReader inData = new BufferedReader(isr);
String str;
str = inData.readLine();
return (new Double(str)).doubleValue();
}
/**
* 入口主函數(shù)
*
* @param args
* Unused.
* @return Nothing.
* @exception IOException
* On input error.
* @see IOException
*/
public static void main(String args[]) throws IOException {
SquareNum ob = new SquareNum();
double val;
System.out.println("請輸入一個數(shù): ");
val = ob.getNumber();
val = ob.square(val);
System.out.println("平方值是: " + val);
}
}
我在eclipse里寫了這個類，右鍵export，選擇Java/javadoc 然后按提示確認，控制臺輸出：
正在加載程序包com.coder4j.jse.javadoc的源文件... 正在構(gòu)造 Javadoc 信息... 標準 Doclet 版本 1.7.0_75 正在構(gòu)建所有程序包和類的樹... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/com/coder4j/jse/javadoc/SquareNum.html... /Users/panda/Documents/lunaspace/code4j/src/com/coder4j/jse/javadoc/SquareNum.java:52: 警告 - 不能在返回類型為空的方法中使用 @return 標記。 正在生成/Users/panda/Documents/lunaspace/code4j/doc/com/coder4j/jse/javadoc/package-frame.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/com/coder4j/jse/javadoc/package-summary.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/com/coder4j/jse/javadoc/package-tree.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/constant-values.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/com/coder4j/jse/javadoc/class-use/SquareNum.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/com/coder4j/jse/javadoc/package-use.html... 正在構(gòu)建所有程序包和類的索引... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/overview-tree.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/index-files/index-1.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/index-files/index-2.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/index-files/index-3.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/index-files/index-4.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/deprecated-list.html... 正在構(gòu)建所有類的索引... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/allclasses-frame.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/allclasses-noframe.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/index.html... 正在生成/Users/panda/Documents/lunaspace/code4j/doc/help-doc.html... 1 個警告
默認在當(dāng)前項目下新增doc目錄
doc/ |--com |--index-files |--resources |--allclasses-frame.html |--allclasses-noframe.html |--constant-values.html |--deprecated-list.html |--help-doc.html |--index.html |--overview-tree.html |--package-list |--stylesheet.css
可以直接訪問index.html,你會看到類似這樣的頁面。
不同的Javadoc版本可能稍有不同喲。
參考資料Java 文檔注釋
文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/65426.html
摘要：方法的基本組成包括名稱參數(shù)返回值方法體方法名和參數(shù)列表唯一的標識出某個方法。如果返回的類型是，則的作用僅是退出方法否則必須返回正確的返回值包名名字可見性約定以域名反轉(zhuǎn)作為包名，用來劃分子目錄，并且全部小寫。 點擊進入我的博客 2.1用引用操縱對象 盡管一切都看作對象，但操縱的標識符實際上是對象的一個引用。 String s; // s是一個String類型的引用， 并沒有任何對象與其...
摘要：下面說一下我們在訴求網(wǎng)二期開發(fā)中使用的代碼注釋規(guī)范，供大家參考下。在代碼不明晰處必須有注釋。在代碼修改處加上修改標識的注釋。在循環(huán)和邏輯分支組成的代碼中加注釋。 代碼注釋是架起程序設(shè)計者與程序閱讀者之間的通信橋梁，最大限度的提高團隊開發(fā)合作效率。也是程序代碼可維護性的重要環(huán)節(jié)之一。所以我們不是為寫注釋而寫注釋。下面說一下我們在訴求網(wǎng)二期開發(fā)中使用的代碼注釋規(guī)范，供大家參考下。 原則： ...
摘要：核心技術(shù)卷第章對象與類面向?qū)ο蟪绦蛟O(shè)計創(chuàng)建標準類庫中的類對象如何編寫自己的類傳統(tǒng)的結(jié)構(gòu)化程序設(shè)計首先確定如何操作數(shù)據(jù)，再決定如何組織數(shù)據(jù)。當(dāng)使用構(gòu)造器時，無法改變所構(gòu)造的對象類型。 《Java核心技術(shù) 卷Ⅰ》 第4章 對象與類 面向?qū)ο蟪绦蛟O(shè)計 創(chuàng)建標準Java類庫中的類對象 如何編寫自己的類 OOP 傳統(tǒng)的結(jié)構(gòu)化程序設(shè)計：首先確定如何操作數(shù)據(jù)，再決定如何組織數(shù)據(jù)。 面向?qū)ο蟪绦蛟O(shè)...
摘要：變量和常量中的關(guān)鍵字關(guān)鍵字對的編譯器有著特殊的意義，我們在程序中應(yīng)用時一定不要使用關(guān)鍵字來定義變量或者常量，一定要慎重哦關(guān)鍵字是區(qū)分大小寫的哦，所以和是不一樣的中的標識符標識符就是用于給程序中變量類方法等命名的符號。 變量和常量 java中的關(guān)鍵字 showImg(https://segmentfault.com/img/bVbaF3o?w=519&h=178); 關(guān)鍵字對 Java ...
仔細看看Hello World!應(yīng)用程序 現(xiàn)在你已經(jīng)看到了Hello World!應(yīng)用程序(甚至可能編譯并運行它)，你可能想知道它是如何工作的，這是它的代碼： class HelloWorldApp { public static void main(String[] args) { System.out.println(Hello World!); // Display ...
閱讀 2900·2019-08-30 15:55
閱讀 2009·2019-08-30 14:02
閱讀 1248·2019-08-29 15:23
閱讀 1014·2019-08-29 11:27
閱讀 468·2019-08-26 11:43
閱讀 3196·2019-08-26 10:32
閱讀 1261·2019-08-23 14:41
閱讀 3304·2019-08-23 14:41
