在C/C++中,变量及函数的定义一般都是在.h/.hpp文件中说明原型,而在对应的.c/.cpp文件中来进行实现.
这种情况下,头文件最终是给用户使用的,以便让用户了解有哪些接口可以使用;而.c/.cpp文件是开发者使用的,以便让其它开发人员了解它的实现逻辑.因此这两个文件中肯定都是需要详细的注释的.在.h/.hpp文件中,主要说明函数的使用方法,如参数的意义,返回值的定义等.而.c/.cpp文件中,主要说明函数的实现逻辑等.
不知道上面的做法是否合适.请大家指正!
另外,大家在实际编程过程中是如何做的?
事实上,我自己在实践过程中却总是偏向于把注释写到一个地方,或者注释原型,或者注释实现(前者比较多),甚至干脆两边都写一样的(但这样的话内容经常会不一样).这样的方法让我在编程过程中吃尽了苦头哇.