@apinote
如果您已经在使用Java 8,则可能会看到一些新的Javadoc标签: @apiNote , @implSpec和@implNote 。 他们怎么了? 如果要使用它们,该怎么办?
总览
该帖子将快速查看标签的来源和当前状态。 然后,它将解释它们的含义并详细说明如何将它们与IDE,Javadoc工具一起使用,以及如何通过Maven的Javadoc插件使用。
我在GitHub上创建了一个演示项目,以显示一些示例和Maven pom.xml的必要补充。 为了使Maven规避变得更容易,它已经包含了生成的javadoc 。
语境
起源
新的Javadoc标记是JSR-335的副产品,它引入了lambda表达式。 它们是在默认方法的上下文中提出的,因为它们需要更标准化和更细粒度的文档。
2013年1月,Brian Goetz 提出了动机,并为这些新标签提出了建议。 经过简短的讨论,三个星期后它变成了功能请求。 到4月, JDK Javadoc制造商已更新, 邮件列表通知他们可以使用了。
当前状态
重要的是要注意,新标记未正式记录(它们在Javadoc标记的