注意:以下註解會被javac.exe編譯時忽略。利用反編譯程式將xxx.class --->xxx.java打開看時,會發現所有的註解都不見了
為什麼要註解? 註解是你自己看的或是要給別人運用看的,你不在裡面註解說明寫這個類的細節與用法,改日回頭自己也看不懂,別說他人了...
一般的註解上一節你有看到了吧!這是基本的註解給自己看的
// Architecture.java
/*
這是一個學習程式碼架構的類
*/
單行註解以 // 為開頭
多行註解以 /* 為開頭 */ 為結尾
說明文件的註解 利用javadoc程式幫你的java程式產生使用說明文件。
/** 用來測試產生說明的文件. */
/**
* This is a sample comment
* @auther : ABC
* @version 1.0
*/
說明文件的註解以 /** 為開頭 */ 為結尾
說明文件以HTML標記方式:
@參數 內容
說明文件的註解位置: class(類)、variable(變量) 和 method(方法) 之前。
建議的註解內容：習慣養成,不會回頭看不懂自己寫的程序....
class(類)interfaces(接口)頂端的註解
1.類名稱
2.設計者名稱
3.最後版本的日期
4.該程式的描述
method (方法) 開頭前的註解
1.類別名稱和method名稱
2.該method 的作用目的
3.任何有關該method須注意之處
，例如錯誤狀況處理或該method可處理或
無法處理的特別之處
variable (變數) 開頭前的註解
variable 代表的意義
使用javadoc.exe命令執檔,將源碼檔中的說明文件提取出來,javadoc.exe能根據類別的內容,產生HTML網頁格式的文件。
javadoc.exe用法:請至命令視窗中打入指令: javadoc
用法:
javadoc [options] [packagenames] [sourcefiles]
options選項:
-public僅顯示public類和成員
-protected顯示protected/public類和成員(缺省)
-package顯示package/protected/public類和成員
-private顯示所有類和成員
-d <directory>輸出文件到目標目錄
-version包含@version段
-author包含@author段
-splitindex將索引分為每個字母對應一個文件
-windowtitle <text>文檔的瀏覽器窗口標題
範例: javadoc -d <文檔存放目錄> <源文件名.java>
單一程式
套件
javadoc -d MyDoc xxxx.java
javadoc -d MyDoc package
到包含java程式xxxx.java的目錄內工作(如註解中有使用中文會異常,必須另加參數)
將產生的xxxx.html說明文件,輸出到 MyDoc目錄內。(工作目錄中要先創建MyDoc目錄)
切換到有包含java程式套件的目錄內
將產生的package 相關檔案的說明文件,輸出到 MyDoc目錄內。