Question

评论中注释（注释内容）注释的目的是什么？例如，我在界面中看到以下注释：

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

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

Answer 1

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

Answer 2

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

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

Answer 3

这些注释对于 javadoc 工具很重要。当它为类/ interface / enum / constructor / method生成文档时，如果在/**和*/之间解析内容。

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

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

另外，请查看Oracle的Javadoc home page

Answer 4

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

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

Java：评论中的注释目的？

4 个答案: