Java:注释中注释的目的?

标签 java annotations javadoc

在评论中放置(看起来像)注释的目的是什么?例如,我在接口(interface)中的方法上方看到以下注释:

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

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

最佳答案

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

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

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

另外,看看 Oracle 的 Javadoc home page

关于Java:注释中注释的目的?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/26674097/

相关文章:

java - Twitter4j 与 Twitter hbc

java安全问题

java - 获取项目中的所有注释?

java - Escape unicode在Java中转义

android - javadoc中的引用资源

java - Java实践中修改字符串

android - Android 单声道 : Map Balloons for Mono

constructor - 类主构造函数的 JvmOverloads 注释

Javadoc 错误 - java.lang.reflect.InitationTargetException

java - 使用java获取字符串内特定值的字符串操作