我有一个包含多个文件的C程序,所以我有,例如,stuff.c它实现了一些函数,并stuff.h使用函数原型.
stuff.c
stuff.h
我该如何记录评论中的功能?
我应该在头文件中包含所有文档,文件中的所有文档.c,还是复制两者的文档?我喜欢后一种方法,但后来我遇到问题,我将更新其中一个文档而不是另一个(通常是我进行第一次修改的文件,即如果我先修改头文件,那么它的注释)将反映这一点,但如果我更新实施,只会更改那些评论).
.c
这个问题及其答案也适用于C++代码 - 另请参阅我应该在哪里放置文档注释?
c documentation comments header-files
c ×1
comments ×1
documentation ×1
header-files ×1