注释,声明(在头文件中)或定义(在源文件中)哪个更实用?也许我应该评论两者,或者不评论,并将它们全部放在一个单独的文件中......
您应该完全记录具有最高优先级的头文件.
定义中的注释应该集中在实现细节上,而标题注释应该集中在接口上.
如您所建议的,第三个文档来源也很有用.它应该描述整体概念.
评论头文件的一大优点是,如果您遵循一些简单的语法,您可以自动创建文档.跟你说doxygen你好!