您是否在每个.hpp/.cpp文件的顶部添加信息？

在创建新的C++标头/源文件时,您将哪些信息添加到顶部？例如,您是否添加了日期,您的姓名,文件说明等？您是否使用结构化格式来获取此信息？

例如

// Foo.cpp - Implementation of the Foo class
// Date: 2008-25-11
// Created by: John Smith

我认识的一个团队将CVS提交消息嵌入到每个文件的脚下,但我不确定我是否想要走这么远......

有关创建文件的人员以及编辑文件的时间和人员以及何时编辑的信息都在源代码管理中.如果您的团队在签到评论方面有良好的做法,那么您也会知道每次更改的原因.不需要对那些东西发表评论.

我认为100%合法 - 甚至 - 只要有必要,就可以用一个注释块来解释类/模块的用途.当下一个人去改变它时,他们会更好地了解整体愿景以及这个文件是否适合他们的变化.

有些商店在源文件评论中加入了版权声明和其他法​​律文件夹.这让我感到很愚蠢 - 如果您的(非OSS)源代码在您不知情或未经许可的情况下将其发送到其他人的服务器上,则版权声明可能不会阻止他们对其进行任何操作.IANAL,YMMV.