将文件信息添加到程序中。
/**
* @Author: Kyle
* @Date: 9-29-2010
* @Description: Stack overflow question!
*/
我这样做了吗？我有一个C编程课程，我一直在用类似的东西编写我的程序。
另外......我在哪里可以包含文件的版本信息？我会在日期之前加入吗？
/**
* @Author: Kyle
* @Date: 9-29-2010
* @Version: 1.000
* @Description: Stack overflow question!
*/
适当的约定是什么？谢谢。
答案 0 :(得分：1)
如果您提供所有信息并保持所有代码之间的格式一致，那么每个程序员都不会使用真正的约定。
这听起来像是你使用某种doxygen格式，但是我很确定它不会在使用'@'的文件开头接受数据。
就个人而言，我会删除'@'以便让浏览程序员更清楚，但那就是我。如果你真的需要稍后重新格式化以符合其他一些文档生成程序，那么如果你做坚持某事，那么只需编写一个程序将你的源代码转换为所需的格式。我很确定可以修改很多这些程序来改变他们使用的格式。
有些人将许可证全部放在他们的代码文件中，但我个人认为我的项目完全不受影响，并且在发布之前使用自动程序填写它。
所以最后的回答，使用一些清晰而恒定的东西。
答案 1 :(得分：1)
考虑将模块的简短描述作为评论的第一行。包含原作者的电子邮件ID是一个很好的做法，以便将来的维护者可以联系他。您可能还希望包含版权和许可信息：
/**
* Stack overflow question!
* Copyright (C) 2010 Kyle <contact@kyle.com>
* Date: 9-29-2010
*/