JBuilder2005创建开发文档之编写注释 - 编程入门网

1) /**@notice 这是用于表示性别的变量，合法值只能为MALE和FEMALE*/

2) protected int sex;

对应的Javadoc文档如下图所示的文档：

图14 自定义Javadoc标签生成的文档

其中"注意"为Create Custom Tag对话框中的Heading text的内容，在上图中我们特地标识出来。

JBuilder2005创建开发文档之编写注释(4)

4、使用代码模板

在第4章中我们曾经介绍过代码模板，你同样可以为常用的注释块创建一个Javadoc模板，"多快好省"地录入Javadoc注释。

按照习惯方式，每个类都需要一个类注释，类注释都是相似的，下面我们就来创建一个类注释代码模板，这个代码模板如下所示：

代码清单 2 类注释代码模板

1. /** 2. * <pre>|</pre> 3. * @see 4. * @version $Version, 2005-04-| 5. * @author $Author 6. * @since JDK1.3 7. */

1) Tools->Perferences...->Editor->Templates->Common，点击Common设置页的Add...按钮，弹出New Code Template对话框，如下图所示：

图15 创建新代码模板对话框

·Template name：clscmt 模板的名字

·Description：class’s comment 模板描述信息

2) 在Code中录入代码清单 2的代码，其中带$前缀的标识是一个宏操作符，在调整模板录入注释块后，宏将被替换成具体的值，你可以通过Macro...按钮，在Insert Macro对话框中选择一个宏，如下图所示：

图16 插入宏对话框

3) 录入代码模板后，按OK返回Common设置页，再按OK后完成创建clscmt代码模板。

创建完clscmt模板后，你就可以在编辑器中用Ctrl+J调用这个模板了，如下图所示：

图17 调用clscmt代码模板

JBuilder2005创建开发文档之编写注释(5)

录入clscmt代码模板后，将产生一个类注释块，原$Author和$Version宏已经被替换成Project->Project Properties...->General设置页的class Javadoc fields列表中所设置的值了，如下图所示：

图18 用代码模板录入Javadoc注释块

此时，General设置页的class Javadoc fields列表的设置情况如下图所示：

图19 Javadoc域设置

凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务，公司网站：http://www.lingzhong.cn 为了给广大客户了解更多的技术信息，本技术文章收集来源于网络,凌众科技尊重文章作者的版权，如果有涉及你的版权有必要删除你的文章，请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息，谢谢!