作者：徐建祥
日期：
2006-12-04
1
、
javadoc
命令
用法：
javadoc [options] [packagenames] [sourcefiles] [classnames] [@files]
選項(xiàng)：
?
??? -public ??
僅顯示
public
類和成員
?
??? -protected ????
顯示
protected/public
類和成員
(
缺省
)
?
??? -package ?????
顯示
package/protected/public
類和成員
?
??? -private ?
顯示所有類和成員
?
??? -d <directory> ?????
輸出文件的目標(biāo)目錄
?
??? -version ?
包含
@version
段
?
??? -author ??
包含
@author
段
?
??? -splitindex ????
將索引分為每個(gè)字母對(duì)應(yīng)一個(gè)文件
?
??? -windowtitle <text> ?????
文檔的瀏覽器窗口標(biāo)題
2
、
JBuilder
用法：
Select
File > New > Build > Javadoc
from the menu bar
and click OK,
Select
Rebuild
from the Standard Doclet 's pop-up menu.
?
Messages
窗口顯示的
Javadoc
日志如下：
|
Standard Doclet
?? StdOut
?????
正在裝入軟件包
org.anymobile.gateway
的源文件
...
?????
正在裝入軟件包
org.anymobile.gateway.util
的源文件
...
?????
正在構(gòu)造
Javadoc
信息
...
?????
標(biāo)準(zhǔn)
Doclet
版本
1.5.0_03
?????
正在構(gòu)建所有軟件包和類的樹
...
?????
正在生成
E:\Project\jbproject\ShotMessageModem\doc\overview-frame.html...
?????
正在生成
E:\Project\jbproject\ShotMessageModem\doc\constant-values.html...
?????
正在生成
... ...
?????
正在構(gòu)建所有軟件包和類的索引
...
?????
正在生成
E:\Project\jbproject\ShotMessageModem\doc\overview-tree.html...
?????
正在生成
E:\Project\jbproject\ShotMessageModem\doc\deprecated-list.html...
?????
正在生成
... ...
?????
正在構(gòu)建所有類的索引
...
?????
正在生成
E:\Project\jbproject\ShotMessageModem\doc\allclasses-frame.html...
?????
正在生成
E:\Project\jbproject\ShotMessageModem\doc\allclasses-noframe.html...
?????
正在生成
E:\Project\jbproject\ShotMessageModem\doc\index.html...
?????
正在生成
E:\Project\jbproject\ShotMessageModem\doc\overview-summary.html...
?????
正在生成
E:\Project\jbproject\ShotMessageModem\doc\help-doc.html...
?????
正在生成
E:\Project\jbproject\ShotMessageModem\doc\stylesheet.css...
?????
注意：可能覆蓋將來的標(biāo)準(zhǔn)標(biāo)記的自定義標(biāo)記：
@todo
。為了避免出現(xiàn)可能的覆蓋，請(qǐng)?jiān)谧远x標(biāo)記名稱中至少使用一個(gè)句點(diǎn)字符
(.)
。
?????
注意：未找到的自定義標(biāo)記：
? @todo
|
3
、
Eclipse
用法：
Select Project > Generate Javadoc from the menu bar or
Open the Export wizard by doing one of the following:
-
Selecting
Export
from the selection's pop-up menu or
-
Selecting
File > Export
from the menu bar.
In the resulting dialog, select Javadoc from the list and press Finish.
?
Console
窗口顯示的
javadoc
日志如下：
|
Loading source files for package org.anymobile.gateway...
Constructing Javadoc information...
Standard Doclet version 1.4.2_02
Generating E:\Project\eclipse\GSMGateway\docs\constant-values.html...
... ...
Building tree for all the packages and classes...
Generating E:\Project\eclipse\GSMGateway\docs\org\anymobile\gateway\class-use\Globals.html...
... ...
Building index for all the packages and classes...
Generating E:\Project\eclipse\GSMGateway\docs\overview-tree.html...
... ...
Building index for all classes...
Generating E:\Project\eclipse\GSMGateway\docs\allclasses-frame.html...
Generating E:\Project\eclipse\GSMGateway\docs\allclasses-noframe.html...
Generating E:\Project\eclipse\GSMGateway\docs\index.html...
Generating E:\Project\eclipse\GSMGateway\docs\packages.html...
Generating E:\Project\eclipse\GSMGateway\docs\overview-summary.html...
Generating E:\Project\eclipse\GSMGateway\docs\overview-frame.html...
... ...
Generating E:\Project\eclipse\GSMGateway\docs\package-list...
Generating E:\Project\eclipse\GSMGateway\docs\help-doc.html...
Generating E:\Project\eclipse\GSMGateway\docs\stylesheet.css...
|
?
文檔資料：
Reference: How to Write Doc Comments for the Javadoc Tool
?????? http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
"Javadoc Tags" (Windows platforms)
http://java.sun.com/j2se/1.4/docs/tooldocs/win32/javadoc.html#javadoctags
Reference: Javadoc FAQ??????
?????? http://java.sun.com/j2se/javadoc/faq/index.html
"javadoc
，在
Java
的注釋上做文章
"
?????? http://outinn.diy.myrice.com/book/javadoc/
"Code Conventions for the JavaTM Programming Language"
?????? http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
"JavaDoc "
?????? http://supportweb.cs.bham.ac.uk/documentation/tutorials/docsystem/build/tutorials/javadoc/javadoc.html
posted on 2006-12-04 15:10
Xu Jianxiang 閱讀(812)
評(píng)論(0) 編輯 收藏 所屬分類:
Java Tech