带有作者姓名的代码是绝对必要的吗?

根据CodeComplete,注释用于说明代码的目的。将其用于其他目的可能会导致“注释衰减”。

这就是说,跟踪代码所有权、更改日志和最后修改文件的人IMHO是SVN之类的源代码管理repo的工作,不应该在注释中。除非是某种许可证。或者使用IDE的书签系统来跟踪谁编写了一个函数,以及谁是该函数的负责人。

不过,这一切只值我2美分。

如果代码受源代码管理,则为否。
这种数据应该存储在源代码存储库中。

显然,这种信息(对于广泛部署的代码库)是最重要的 文件 仅限关卡。
java.lang.Boolean 在Java中:

/**
 * [...]
 * In addition, this class provides many methods for 
 * converting a {@code boolean} to a {@code String} and a 
 * {@code String} to a {@code boolean}, as well as other 
 * constants and methods useful when dealing with a 
 * {@code boolean}. 
 *
 * @author  Arthur van Hoff
 * @version 1.60, 05/05/07
 * @since   JDK1.0
 */
public final class Boolean implements  java.io.Serializable,
    Comparable<Boolean> {
[...]

您没有从一开始的所有作者,只有最新的作者,与最近修改相关联的最后一个主要版本,以及类的原始介绍版本。

这对我有帮助 API tooling

但是关于作者的信息仍然局限于文件,而不是函数:他代表类中所有函数的协调器或聚合管理器,尽管随着时间的推移可能有多个参与者。

因此,这是一个很好的例子 值得显式地放在文件中的信息,而不是 私有的 元数据(谁写什么),作为所有其他元数据(日期、版本、分支、合并信息等)存储在源代码存储库中。

是的,代码将在源代码管理中

blame

特别是对于团队开源项目,指出特定代码段的作者可能是有用的或必要的。但是对每一个函数进行注释似乎真的太过分了,尤其是因为一个类的大部分都是由同一个作者编写的(nest ce pas?)。我喜欢Java库为每个类指定作者的约定。不知何故,这似乎是正确的权衡。

另一方面,如果你是一个类的合著者,那么如果其他人在其中编写了糟糕的代码,你就应该受到责备。我实际上认为这是一个 好的 事情一个类(至少在OOP中)是一个实体,因此质量由其整体质量决定。如果一个函数是坏的,那么整个类也是坏的。

不,你或你工作的公司隐含着版权。但是,出于跟踪的目的,可以问那个人这段代码后来做了什么。

在一些项目中,作者的名字可以用来给那些在开发中付出比预期更多努力的人以应有的荣誉。这种认知可以提高动机。

是的,它是需要的。如果可能的话,请给出日期和姓名。它用于跟踪目的,并使其他人有权了解该功能的所有者。