c - 节目信息；惯例，我做得对吗？

Question

将文件信息添加到程序中。

/**
* @Author: Kyle
* @Date: 9-29-2010
* @Description: Stack overflow question!
*/

我这样做对吗？我有一门 C 编程类(class)，并且我一直在用类似的东西编写我的程序。

另外...我应该在哪里包含文件的版本信息？我可以将其包含在日期下吗？

/**
* @Author: Kyle
* @Date: 9-29-2010
* @Version: 1.000
* @Description: Stack overflow question!
*/

正确的约定是什么？谢谢。

Answer 1

只要您提供所有信息并保持所有代码之间的格式一致，就没有每个​​程序员都使用的真正约定。

听起来您使用了某种 doxygen 格式，但是我很确定它不接受使用“@”的文件开头的数据。

就我个人而言，我会删除“@”以使浏览程序员更清楚，但这只是我。如果您确实需要稍后重新格式化它以符合其他一些文档生成程序，那么如果您坚持某些东西，那么只需编写一个程序将源代码转换为所需的格式即可。我很确定这些程序中的很多都可以修改以更改它们使用的格式。

有些人为他们的所有代码文件添加了许可证，但就我个人而言，我让我的项目不包含所有这些内容，并在发布它们之前使用自动化程序来填充它们。

所以最终的答案是，使用对你来说清晰且恒定的东西。