Java：注释中注释的目的？答案

【问题标题】：Java: Purpose of annotations in comments?Java：注释中注释的目的？
【发布时间】：2014-12-27 17:45:03
【问题描述】：

放置在 cmets 中的注释（看起来像什么）的目的是什么？例如，我在接口中的方法上方看到以下注释：

/**
 * Create saved search
 * REST: POST /lifecycles/savedsearches
 * @param controlParameters control parameters
 * @param search savedSearch object
 * @throws ProcessingException if any processing exceptions
 * @return Updated Object
 */

我理解评论的意思，只是想知道为什么使用这种语法。

【问题讨论】：

标签： java annotations javadoc

【解决方案1】：

这在生成 Javadoc 时使用。这样，您可以为传递给函数的每个参数添加解释性文本，您可以解释返回的内容和可能引发的异常，然后 Javadoc 生成器会将您的 cmets 添加到相应位置的方法文档中。

然后您可以使用它来生成基于这些 cmets 记录您的代码的 html 页面。

【讨论】：

【解决方案2】：

这些注释对于javadoc 工具很重要。当它为类/接口/枚举/构造函数/方法生成文档时，如果解析/** 和*/ 之间的内容。

对于单个 javadoc 内容，该工具会生成一个基于 HTML 的文档，该文档由多个段落组成。当它检测到注释（例如@param）时，它会将相应的@param 信息添加到有关方法的Parameters 的段落中。

例如检查String#concat(String str) 方法。

另外，看看 Oracle 的Javadoc home page

【讨论】：

谢谢 - 非常清楚。它还会解析使用// 声明的 cmets 吗？
没有。只有以/** 开头并以*/ 结尾的那些

【解决方案3】：

如果您生成 Javadoc，则使用此语法。

http://www.oracle.com/technetwork/articles/java/index-137868.html

【讨论】：

【解决方案4】：

然后用于生成 javadoc。见http://www.oracle.com/technetwork/articles/java/index-jsp-135444.html

【讨论】：