随笔-1  评论-68  文章-98  trackbacks-0

作者:徐建祥

日期: 2006-12-04

1 javadoc 命令

用法:

   javadoc [options] [packagenames] [sourcefiles] [classnames] [@files]

选项:

      -public    仅显示 public 类和成员

      -protected      显示 protected/public 类和成员 ( 缺省 )

      -package       显示 package/protected/public 类和成员

      -private   显示所有类和成员

      -d <directory>       输出文件的目标目录

      -version   包含 @version

      -author    包含 @author

      -splitindex      将索引分为每个字母对应一个文件

      -windowtitle <text>       文档的浏览器窗口标题

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 的源文件 ...

      正在构造 Javadoc 信息 ...

      标准 Doclet 版本 1.5.0_03

      正在构建所有软件包和类的树 ...

      正在生成 E:\Project\jbproject\ShotMessageModem\doc\overview-frame.html...

      正在生成 E:\Project\jbproject\ShotMessageModem\doc\constant-values.html...

      正在生成 ... ...

      正在构建所有软件包和类的索引 ...

      正在生成 E:\Project\jbproject\ShotMessageModem\doc\overview-tree.html...

      正在生成 E:\Project\jbproject\ShotMessageModem\doc\deprecated-list.html...

      正在生成 ... ...

      正在构建所有类的索引 ...

      正在生成 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...

      注意:可能覆盖将来的标准标记的自定义标记: @todo 。为了避免出现可能的覆盖,请在自定义标记名称中至少使用一个句点字符 (.)

      注意:未找到的自定义标记:   @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 阅读(796) 评论(0)  编辑  收藏 所属分类: Java Tech

只有注册用户登录后才能发表评论。


网站导航: