添加元信息是否足以将自己包括为类的额外@author?

时间:2011-10-05 18:47:00

标签: java jpa javadoc

我和我的同事正在为我们项目的一小部分开发领域模型。最近,他将骨架实体类提交到我们的SVN存储库,而不添加JPA注释。同时我设计了物理数据模型并创建了相应的数据库对象。现在我需要将实体类映射到数据库,对继承策略和其他事情做出各种决定。注释类是否使我有资格成为额外的@author?我知道通常情况下,当对课程进行一些重要更改时,可以添加额外的@author标记。但是,如果我只提供元信息呢?

修改
这不是关于自我。这是关于它是否普遍并且被认为是一种好的做法 有人说@author标签是无用的,因为无论如何代码都在版本控制之下 但我个人并不这么认为。在某些情况下,此标记可能非常有用。

3 个答案:

答案 0 :(得分:2)

我总是将@author添加到我做出重大贡献的课程中。我遇到了很多情况,一位同事创建了骷髅,或者一些不完整的东西,我将自己添加为@author。

对我来说,这不是关于自我,而是对于那些必须查看文件的其他人的快速参考,如果他们需要信息,他们不必返回版本控制日志。

答案 1 :(得分:1)

不要让自我妨碍软件。你真的在乎吗?

无论如何,设计JPA注释,层次结构和相关代码要比创建框架实体困难得多,所以如果你真的关心,那就添加它。

请注意,您的VCS会跟踪谁在贡献哪些工作,因此将哪些代码放在应用中的位置始终存在单一的事实。

答案 2 :(得分:1)

在我看来,可以将自己添加为@author。配置JPA注释可能并不那么容易。如果你不确定问你的同事。拥有SVN(和单独的帐户),很容易找出谁做了什么。