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

　　3、自定义的Javadoc标签

　　JBuilder允许你为了实现特殊的用途自定义扩展的Javadoc标签。在这小节里，我们来定义一个名为notice的自定义标签。

　　1．Project->Project Properties...->Build->Javadoc，在Javadoc设置页中列出了所有自定义的Javadoc标签。由于todo标签是JBuilder本身自定义标签，所以todo出现在列表中，如下图所示：

图 12 Javadoc自定义标签设置页

　　2．按New...按钮，弹出Create Custom Tag对话框，如下图所示：

图 13 创建自定义Javadoc标签对话框

　　·Tag name：notice，标签名

　　·Heading Text：出现在Javadoc 文档中的标题。

　　·Placement options：选择所有的选项，表示这个标签可以对代码中的任何类型元素进行注释。

　　3．按OK创建这个notice自定义标签。

　　打开Person.java用notice标签为sex值域写Javadoc注释：

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

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

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

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