将代码归于某个作者的一般规则是什么?

时间:2010-08-29 07:15:44

标签: java javadoc

通常很多人都会参与应用程序开发过程(例如java / j2ee项目)。有时一个人(比如foo@bar.com)负责编写某个文件的代码,或者某些其他人可能更改了代码。

您是否将文档顶部的作者信息归因于下面提到的方案2进行修改的任何用户,或者是方案1中的主要作者?是否有特定的顺序,应该在更改时添加作者信息?

/**
 * @author Foo Bar, (foo@bar.com)
 *
 */

/**
 * @author Foo Bar, (foo@bar.com)
 * @author Foo Foo, (foo@foo.com)
 * @author Bar Bar, (bar@bar.com)
 *
 */

2 个答案:

答案 0 :(得分:4)

我个人认为作者不应该列在代码中。这有几个原因:

  • 没有“所有权”的主张。代码是每个人的责任。
  • 源存储库可以准确地回答有关谁编辑了相关代码的任何查询,直到第一天(希望甚至为什么)。无需手动维护。

答案 1 :(得分:0)

对于内部项目,我只是标记自己,如果我的工作代表了一些相当大的变化,或者这是第一次使用该课程一段时间,所以我的同事知道我已经在课堂上工作,我很熟悉它。在我看来,每个新作者都应该添加到列表中。

在我们公司,它真正归结为个体工程师,我们没有作者标签指南,因为我们使用Fisheye,它提供的带注释的源视图可以更好地表示正在发生的事情。

这实际上取决于您的驱动程序用于记录创作信息的内容。当然,应该注意原始的建筑师/工程师和任何重要的作者,因为如果它是一个开源项目,你可能希望对它更加严格。看看其他人如何处理这个问题会很有趣。