创建新的 C++ 头文件/源文件时，您会在顶部添加哪些信息？例如，您是否添加日期、您的姓名、文件描述等？您是否使用结构化格式来存储此信息？
e.g.
// Foo.cpp - Implementation of the Foo class
// Date: 2008-25-11
// Created by: John Smith
我认识的一个团队将 CVS 提交消息嵌入到每个文件的底部，但我不确定我是否想要走这么远......
有关文件创建者、时间、编辑者和时间的信息全部位于源代码管理中。如果您的团队在签入评论方面有良好的实践，那么您也会知道每次更改的原因。不需要对那些东西发表评论。
我认为只要有必要，放置注释块来解释类/模块的目的是 100% 合法的，甚至是明智的。当下一个人去更改它时，他们将更好地了解整体愿景以及该文件是否适合他们的更改。
一些商店将版权声明和其他法律文件夹放在源文件注释中。这让我觉得很愚蠢——如果你的（非 OSS）源代码在你不知情或未经你许可的情况下被放到了别人的服务器上，那么版权声明可能不会阻止他们用它做任何事情。 IANAL，YMMV。
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
