在生成的代码中包含 Javadoc 注解

要包含 Javadoc 注解,如平时一样生成代码。

关于此任务

缺省情况下,Javadoc 注解生成可用于 Java™ 开发者的 IBM® Rational® Rhapsody® 项目。

在生成的代码中,可根据您为模型元素提供的描述查看 Javadoc 注解。操作注解还包含您为操作参数提供的所有描述。

如果在代码中看不到此类注解,那么请对正在使用的配置打开“特征”窗口,并验证设置选项卡上的生成 Javadoc 注解复选框已选。如果该选项已选,而您在生成的代码中仍然看不到 Javadoc 注解,那么请阅读 Javadoc 注释的故障诊断中所列的建议。

除了生成这些基本的 Javadoc 注解以外,您还可以令 Rational Rhapsody 包含以下标准 Javadoc 标记:author、deprecated、return、see、since 和 version。要在生成的代码中包含这些 Javadoc 标记:

过程

  1. 请对要记录的模型元素打开“特征”窗口。
  2. 通过为标记选项卡上显示的各标记提供值来添加 Javadoc 内容。
  3. 对于要记录的每个模型元素重复此过程。
  4. 生成代码。

结果

代码包含 Javadoc 注解后,您即可使用标准 Javadoc 过程生成 Javadoc 报告。


反馈