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的帮助文档了。