Java：评论中注释的目的是什么？

在注释中放置注释的目的是什么（看起来像什么）？例如，我看到在界面上面的方法如下评论：Java：评论中注释的目的是什么？

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

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

来源

2014-10-31 Jeff Levine

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

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

另外，看看甲骨文的Javadoc home page

来源

2014-10-31 12:02:21

谢谢 - 非常清楚。它是否也会解析用'//'声明的注释？ – 2014-10-31 12:05:26

不可以。只有那些以'/ **'开头并以*// – 2014-10-31 12:06:05

它被用于javadoc生成。请参阅http://www.oracle.com/technetwork/articles/java/index-jsp-135444.html

来源

2014-10-31 11:54:03 JiriS

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

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

来源

2014-10-31 11:54:16 Simon

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

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

来源

2014-10-31 11:55:21 sinclair

Java：评论中注释的目的是什么？

回答

相关问题