在评论中放置(看起来像)注释的目的是什么?例如,我在接口(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/