添加 Javadoc 标记

Javadoc 生成机制允许您定义想要使用的新 Javadoc 标记。

关于此任务

要定义 Javadoc 标记:

过程

  1. 创建 JavaDocProfile 概要文件的可写副本,方法是选择文件 > 添加到模型,然后选择文件 <Rational Rhapsody 安装路径>\Share\
    Profiles\JavaDoc\JavaDocProfile.sbs
    (当产品指示模型中存在此概要文件时,选择替换现有单元选项。)
  2. 在概要文件中创建 Javadoc 标记。当您创建标记时,请从适用于列表选择相应项。
  3. 为元素的相关类型修改 DescriptionTemplate 属性的值。使用 $<tagname> 以使产品在 Javadoc 注解中包含标记文本。
  4. 对相关类型的特定元素打开“特征”窗口,并在标记选项卡上为您添加的新 Javadoc 标记提供值。

示例

过程

  1. 在您的概要文件下创建一个名为 codeReviewer 的新标记。 从适用于列表选择
  2. 对于 JAVA_CG::Class::DescriptionTemplate 属性,向属性值添加以下内容:[[ * @codeReviewer $codeReviewer]]
  3. 对于模型中的一个或多个类,打开“特征”窗口,并在标记选项卡上,输入 Steve 作为标记 codeReviewer 的值。

结果

当您在这些更改后为模型生成代码时,这些类的 Javadoc 注解包含 @codeReviewer Steve


反馈