分享
 
 
 

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

王朝other·作者佚名  2008-05-19
窄屏简体版  字體: |||超大  

虽然在java文件中编写注释后,马上可以切换到内容窗格的Doc视图页代码中对应的Javadoc文档,但在Doc视图页中生成的文档仅是不完整的"范本"。首先,没有导航树,其次没有生成通过@see或@link关联内容的链接。所以你可以把Doc视图页中的Javadoc文档看成是Javadoc最终版本的预览。

要为工程产生完整的Javadoc文档,必须通过Javadoc向导,在这节里,我们用Javadoc向导为javadoc工程创建完整的Javadoc文档。

1.File-New...-Build-双击Javadoc图标,弹出创建Javadoc的向导,如下图所示:

图 23 选择可用的doclet

Doclet name中包含了两个选项,分别是Standard Doclet和JDK 1.1 Doclet。Standard Doclet将采用JDK 1.3以上的格式创建Javadoc文档,假如选用JDK 1.1 Doclet,许多设置选项将无法使用。

这里,我们接受默认的Standard 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: Cannot find doclet com.sun.tools.doclets.oneone.OneOne

on the class path. Check available in JDK configured to be used.

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

图 24 指定节点名及创建选项

·Name:Stand Doclet,在完成这个向导后,在工程窗格资源树中会创建一个节点,表示工程的Javadoc文档,这里设置的就是节点的名字。

·Output Directory:D:/javadoc/doc,Javadoc文件的输出目录。接受这个默认的设置。

·4个创建选项。

* Show console output:在创建Javadoc文档时,在信息窗格中显示出创建文档的报告信息,在默认情况下,这个选项没有勾选,我们将其选中,以便在创建文档时,看到各种报告信息,如下图所示:

图 25 创建Javadoc文档时的报告信息

* Always run Javadoc When building the PRoject:设置是否需要在Rebuild工程时,创建Javadoc文档。在默认情况上这个选项是勾选的,由于每次Rebuild工程时,都会连带编译并产生工程的Javadoc文档,这将浪费较多的时间。你大可在需要创建Javadoc文档时,通过资源树的Javadoc节点手工来创建它。所以我们去除这个选项设置。

* Use project JDK when running Javadoc:勾选这个设置项中,JBuilder将用工程所用的JDK所带的Doclet来创建Javadoc文档,否则使用JBuilder自带的JDK1.4所带的Doclet。

* Include project test path directory:用JUnit测试框架生成的测试类,将统一放在工程目录的test子目录下。选择该设置项后,测试类的Javadoc文档将和工程其他类的文档一起输出。在一般情况下,这并不是我们所希望的,所以去除这个选项。

按Next到下一步。

3.指定包及可视域级别

图 26 设置包及可视域

你可以为整个工程的所有类包(这里不包括JUnit测试类)生成Javadoc文档,也可以仅为某几个包产生Javadoc文档。假如是后者,则取消Entire project的设置项,通过Add...按钮指定包。

通过Lowest visibility to document指定以何种可视域级别输出文档,默认为Package,也就是说将所有默认可视域的方法、值域的注释输出,而private的方法、值域的注释则不输出。我们接受默认的级别。按Next到最后一步。

4.设置Doclet命令行参数

Javadoc向导创建Javadoc节点后,通过节点创建Javadoc文档时,JBuilder将直接调用JDK bin目录下的Javadoc.exe工具创建Javadoc文档。而Javadoc.exe命名共有54个控制参数,在这一步里,JBuilder答应直接用勾选的方法设置一些常见的控制参数。假如需要进行更多的控制,可以通过Additional options来设置,如下图所示:

图 27 设置Javadoc.exe控制参数

在默认情况下@author、@version、Generate "Use" page和Separate index per letter都未选中,我们将所有的选项都选中,并且在Additional options中填入"-header Javadoc测试工程 -footer abc公司版权所有",以使Javadoc文档包含标题头和脚注。

按Finish完成向导,此时在工程窗格资源树中多了一个Standard Doclet的节点,如下图所示:

图 28 工程窗格中的Javadoc节点

鼠标右击该节点,在弹出的菜单中选择Rebuild,JBuilder将调用Javadoc.exe工具,在工程目录的doc子目录下创建工程的Javadoc文档。

在完成创建后,Standard Doclet节点可以展开,下面是一个index.Html,你可以双击这个文件,用JBuilder的浏览器查看,如下图所示:

图 29 用JBuilder浏览器查看创建的Javadoc文档

当然,你也可以到<工程目录/doc目录下,用IE浏览工程的Javadoc文档了。假如你的工程是一个类库,你最好将Javadoc和类文件一起打成JAR包,这样别人就可以引用这个类库时,就可以查看到这个Javadoc的帮助文档了。

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有