评论C代码,头文件和源文件 - 代码日志

评论C代码,头文件和源文件

我正在寻找一个“最佳实践”记录我的C代码。像任何项目一样,我有一些头文件“.h”和相应的源文件“.c”

在头文件中你放置什么样的评论?在源文件中?
问题出现了,因为我的头文件很好,我的c文件看起来像一团糟。

保持代码好评的最佳做法是什么?

该标题适用于代码的用户。所以在那里我记录界面:如何使用它,前提条件和后置条件等等。

.c文件用于维护者。在那里,我记录了实现:事情在内部工作,以及他们为什么这样工作。

http://stackoverflow.com/questions/2592030/commenting-c-code-header-and-source-files

本站文章除注明转载外,均为本站原创或编译
转载请明显位置注明出处:评论C代码,头文件和源文件