JBuilder2005创建开发文档之创建文档

JBuilder2005创建开发文档之创建文档,第1张

JBuilder2005创建开发文档之创建文档,第2张

虽然在Java文件中写入注释后,可以立即在内容窗格的文档视图页面代码中切换到相应的javaDoc文档,但是文档视图页面中生成的文档只是一个不完整的“模板”。首先没有导航树,其次没有通过@see或者@link链接到相关内容。因此您可以在文档视图页面中看到Javadoc文档,作为javaDoc最终版本的预览。

要为项目生成完整的Javadoc文档,您必须完成Javadoc向导。在本节中,我们将使用javadoc向导为Javadoc项目创建一个完整的Javadoc文档。

1.文件->新建...-> build->双击Javadoc图标,弹出创建Javadoc向导,如下图所示:

小文件名称中有两个选项,即标准小文件和JDK 1.1小文件。标准小文件将创建JDK 1.3或以上格式的Javadoc文档。如果使用JDK 1.1 Doclet,许多设置选项将不可用。

这里,我们接受默认的标准Doclet选项,并按Next进入下一步。

注意:

JDK 1.4和JDK5.0不提供对JDK 1.1 Doclet的支持,因此如果您项目的JDK是JDK 1.4或JDK5.0,当您选择JDK 1.1 Doclet创建Javadoc文档时,您会得到以下错误消息:

JDK 1.1 Doclet:在类路径上找不到Doclet com . sun . tools . doclets . one one . one one
。在JDK可用的检查配置为使用。

2.指定Javadoc节点名称和创建选项。

名称:StandDoclet,完成此向导后,将在项目窗格的资源树中创建一个节点来表示项目的Javadoc文档,在此设置节点的名称。

输出目录:d:/Javadoc/doc,Javadoc文件的输出目录。接受此默认设置。

4个创作选项。

*显示控制台输出:创建Javadoc文档时,所创建文档的报告信息会显示在信息窗格中。默认情况下,此选项是未选中的,因此在创建单据时,我们可以看到各种报表信息,如下图所示:

*在构建项目时始终运行javadoc:设置在重建项目期间是否需要创建Javadoc文档。默认选中该选项,因为每次构建重建项目时,都会编译生成项目的Javadoc文档,这样会浪费更多的时间。当需要创建Javadoc文档时,可以通过资源树的Javadoc节点手动创建。所以我们删除了这个选项设置。

*运行javadoc时使用项目JDK:如果选中此设置,JBuilder将使用项目中使用的JDK的Doclet来创建Javadoc文档,否则,它将使用JBuilder附带的JDK1.4的Doclet。

*包含项目测试路径目录:JUnit测试框架生成的测试类会统一放在项目目录的test子目录中。选择该设置项后,测试类的Javadoc文档将与其他工程类的文档一起输出。一般来说,这不是我们想要的,所以去掉这个选项。

位律师回复
DABAN RP主题是一个优秀的主题,极致后台体验,无插件,集成会员系统
白度搜_经验知识百科全书 » JBuilder2005创建开发文档之创建文档

0条评论

发表评论

提供最优质的资源集合

立即查看 了解详情