您的代码中的注释页眉和页脚是否真的有必要？

Question

许多公司编码标准要求在每个文件中都有一个大的注释页眉和页脚.就像是:

// MyFile.cpp
//
//  Copyright (c) 200x Company ABC
// 
//  This file is a copyrighted... blah blah blah
//

<... some code ...>

// Copyright (c) 200x Company ABC
//
//  Change history:
//     1.0  -  Blah
//     1.1  -  Blah, blah..

所以,问题是 - 为什么我们需要这个？这是否真的有必要声明文件内容的版权,或者这是一个误入歧途的做法已成为标准？在那里工作的公司不需要这样的东西吗？

Answer 1

首先,更改历史记录毫无意义,请使用您的SCM.

版权声明并非严格要求(版权是自动的)¹,但如果您正在发布源代码,那么可能包括它将被认为更安全².完整的许可证声明可能在单独的文件中更好,然后引用(这是Boost所做的).

¹ 维基百科有一个合理的摘要,但你真的需要自己的法律建议.

²特别是律师安全地玩.

Answer 2

我的公司不需要这个......并且更改历史记录的位置应该在源代码控件中而不是代码文件中.