comments - 在源代码文件的顶部添加什么信息？

Question

您认为哪些信息值得放在源代码文件开头的注释中？

我能想到的只是作者的名字，也许还有文件的创建日期(虽然我不确定这些信息是否有任何有用的值(value))。

[编辑] 澄清一下，我的意思不是在类之前的评论，而是在文件的第一行，在包含语句之前以及其他什么。喜欢

/**
 * Author:    Name
 * Created:   11.05.2009
 * 
 * (c) Copyright by Blub Corp.
 **/

Answer 1

在文件头中放什么:

源代码属于

的库/组件

版权详情

源文件中类的简短而有意义的描述

什么不要放在文件头中:

任何复制作为代码本身一部分的低级逻辑的东西。如果在源代码更改时不更新，这可能会导致维护问题。

作者姓名。为什么？

在修订控制系统的世界中，虽然可能有一些代码的初始作者，但最终所有权变得模糊。当代码进入生命周期的维护阶段时尤其如此，所有者可以定期更改。

经过足够的更改，所有代码最终都成为“社区维基”;-)

您是否希望您的名字永远与所有代码相关联，并且清楚地知道在代码死亡之前您不会对代码负责？

创建日期和上次更改日期。这是出于与上面列表类似的原因。修订控制包括此信息 - 为什么在标题中复制它，为自己做更多的工作，并在事情不可避免地发生变化时冒着在评论中留下不准确信息的风险？