源代码管理是否使Javadoc的@author和@since冗余？

Question

在大多数团队中,有一条规则规定@author和@since关键字必须用于所有记录的类,有时甚至是方法.

为了关注重要的事情,我不使用这些关键字,而是依赖于我可以使用源代码管理系统来确定类的作者是谁以及何时存在的事实.

我相信@author和@since来自版本控制尚未普及的时代,我认为它们现在已经相当多余了.你觉得这个怎么样？现代Java项目应该使用它们吗？

Answer 1

我认为@author标签实际上会混淆事物.首先,如果没有明智地更新,那就错了.另外,如果你(不是原作者)改变了一半的课程怎么办？你更新了@author吗？你加一个吗？如果你只改变班级中的几行怎么办？

我也认为它促进了代码所有权,我认为这不是一件好事.应该允许任何人更改文件.如果有@author标签,人们会倾向于让这位作者做出所有改变,而不是自己做,也许在这个过程中学习一些东西.

最后,正如您所说,您可以从VCS获得更详细的相同信息.你在Javadoc中添加的任何内容都是重复的.重复是不好的,对吧？

编辑:其他答案提到您可能无法访问VCS的事实,在这种情况下@author标签是有用的.我谦卑地反对.在这种情况下,您最有可能处理第三方库,或者可能是公司内部不同团队的工件.如果是这样的话,那个人是谁创造了某个班级真的很重要吗？最有可能的是,您只需要知道创建图书馆的实体,并与他们的联系人交谈.