我们真的需要@file或@since JavaDoc标签吗？

Question

您在* .java文件中使用@since或@file JavaDoc标记吗？对我来说，这些标签现在已经过时了。

@file： 有什么好处？如果我想找到一个文件，我使用IDE的“Open Resource”功能并输入类名。 @file标签只是类名的重复。

@Since 绝对没有任何好处。我们有什么版本控制系统？ （这对图书馆有意义，但我特别谈论项目）

您怎么看？

Answer 1

JavaDoc中的注释不适用于开发库的开发人员。这些信息适用于使用此库的开发人员，他们无法访问您的版本控制系统或源项目。

Answer 2

特别是@since注释在尝试找出一个方法可用的库的版本时非常有用。
例如，JDK API文档中有很多示例。当您尝试处理必须使用较旧版本和较新版本API的代码时非常方便（例如，我必须创建必须在服务器上运行的代码，该服务器上只有1.6运行时我们的工作站安装了1.7个JDK，因为我们的大多数软件都运行1.7个运行时。） 哦，不是每个人都可以访问IDE，只需单击另一个文件即可。特别是在服务器上工作时，您经常被限制在命令行和文本编辑器中。