pyg*_*iel 16 c documentation commenting
我正在寻找记录我的C代码的"最佳实践".就像在任何项目中一样,我有一些头文件".h"和相应的源文件".c"
在头文件中你放了什么样的评论？在源文件中？问题出现了,因为我评论了我的头文件,c文件看起来像一团糟.
保持代码评论的最佳做法是什么？
Tho*_*mas 26
标题适用于代码的用户.所以我在那里记录了界面:如何使用它,前置条件和后置条件等等.
.c文件适用于维护者.在那里,我记录了实现:内部如何工作,以及它们为何如此工作.