当前位置:  开发笔记 > 编程语言 > 正文

我应该在C++中评论声明或定义吗?

如何解决《我应该在C++中评论声明或定义吗?》经验,为你挑选了1个好方法。
如何解决《我应该在C++中评论声明或定义吗?》经验,为你挑选了1个好方法。

注释,声明(在头文件中)或定义(在源文件中)哪个更实用?也许我应该评论两者,或者不评论,并将它们全部放在一个单独的文件中......



1> ypnos..:

您应该完全记录具有最高优先级的头文件.

定义中的注释应该集中在实现细节上,而标题注释应该集中在接口上.

如您所建议的,第三个文档来源也很有用.它应该描述整体概念.

评论头文件的一大优点是,如果您遵循一些简单的语法,您可以自动创建文档.跟你说doxygen你好!

推荐阅读
和谐啄木鸟
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有