具有作者姓名的代码绝对必要吗？

Question

是否需要在每个函数甚至文件中添加作者姓名的代码？

是的代码将在源代码管理中,并涉及许多程序员

Answer 1

根据Code Complete,注释用于说明代码的用途.将其用于其他目的可能会导致"评论衰退".

也就是说,跟踪代码所有权,更改日志以及谁最后修改文件,恕我直言,是SVN之类的源控制回购的工作,不应该在评论中.除非它是某种种类的许可证.或者使用IDE的书签系统来跟踪谁创作了一个功能,以及谁负责它.

不过,所有这些只是我的2美分.

Answer 2

如果代码在源代码管理下,没有.
这种数据应该存储在源代码库中.

如果代码要广泛分发(在没有任何类型的存储库的其他环境中),那么是的,这可能是有用的.(一些java源代码确实包含了那种信息,以及代码的某些演变可用的版本号)

显然,这种信息(对于广泛部署的代码库)仅在文件级别.
例如,考虑java.lang.BooleanJava中的源代码:

/**
 * [...]
 * 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时,这可以帮助API工具.

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

因此,这是一个公共信息,值得明确地放在文件中,而不是私有元数据(谁写什么),存储为所有其他元数据(日期,版本,分支,合并信息,. ..)在源代码库中.