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

　　可以通过代码模板快速的录入Javadoc注释，你也可以选择通过Javadoc对话框以一种形象化的方式录入Javadoc注释。此外，JBuilder还提供了各种Javadoc的辅助功能，如JavadocInsight诱导录入，冲突报告和更正，特殊的todo标签等。

　　1、Javadoc对话框

　　在编辑器中，将光标放在类、方法、值域等元素定义处右击，在弹出的菜单中选择Add->Javadoc for XXX将调出Javadoc对话框。
打开Person.java文件，将光标移到构造函数中，依照上述操作步骤调出Javadoc对话框，如下图所示：

图 9 Javadoc对话框

　　在Description中列出了构造函数的描述信息，而Tags中列出构造函数所有Javadoc注释标签。你可以通过对话框右下角的按钮新增、编辑、删除标签，也可以调整它们的位置。

　　下面，我们为构造函数添加一个新的@see标签，链接到Car.drive(int direction,int speed)函数中。

　　1．点击Javadoc for Constructor "Person"对话框的Add...按钮，弹出Add Javadoc Tag对话框，如图 10所示。

　　2．从Tag下拉框中选择see选项。

　　3．在Description中录入javadoc.tool.Car#drive(int,int)。

　　4．按OK返回Javadoc for Constructor "Person"对话框，再按OK在编辑器中生成这个新的标签。

图 10 Add Javadoc Tag对话框

　　实战经验：

　　虽然使用Javadoc对话框可以以一种形象的方式创建Javadoc注释，减少冲突概率，但由于需要在多个弹出的对话框中操作，且需要使用到键盘和鼠标，所以在键入速度和操作连贯性都很差。笔者在开发过程中几乎从未使用这种笨重的方法，既然是己所不欲，当然也不希望读者朋友使用。但初学者却可以通过Javadoc对话框加强对Javadoc标签的理解。

　　2、使用JavadocInsight

　　象MemberInsight、ParameterInsight等一样，JavadocInsight以诱导的方式辅助你快速录入正确的Javadoc标签。

　　由于Javadoc标签都带有@字符，当你录入@字符后JavadocInsight诱导窗口自动弹出，延时时间可以通过Tools->Perferences...->Editor->CodeInsight设置页中调整，默认为250ms。一个典型的JavadocInsight窗口如下图所示：

图 11 JavadocInsight

　　在注释块中除可以用JavadocInsight诱导窗口外，可以通过Ctrl Space使用MemberInsight诱导窗口录入类值域或方法，通过Ctrl Alt Space使用ClassInsight录入类名。JavadocInsight、MemberInsight和ClassInsight有如三剑客，保证快速和正确地录入Javadoc注释段。

提示： 　　JavadocInsight窗口中除todo外都显示为粗体样式，todo标签不是Javadoc标准的标签，而是JBuilder自定义的标签。JBuilder允许定义自定义的Javadoc标签，所有自定义的Javadoc标签显示为非粗体样式。关于自定义Javadoc标签及todo标签的详细内容，参见本文后续的内容。

　　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的内容，在上图中我们特地标识出来。

　　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对话框中选择一个宏，如下图所示：

标签：

版权申明：本站文章部分自网络，如有侵权，请联系：west999com@outlook.com
特别注意：本站所有转载文章言论不代表本站观点，本站所提供的摄影照片，插画，设计作品，如需使用，请与原作者联系，版权归原作者所有