如何用doxygen写程序注释
作者
如何用doxygen写程序注释
本篇文章为大家展示了如何用doxygen写程序注释,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。
接触doxygen是从接触lib3ds库开始的,这个库的源代码使用doxygen作为文档的注释,很爽,直接使用工具就可以生成一个非常漂亮的文档。所以我也开始学着用doxygen作注释。
很简单,一个文件的开始写文档的头
/*!file:filenamebrief:Thisisafile.....*/
对于类
//!ClassDescription
对于函数
/*!Functionparmparm1description1parmparm2description2*/
等等,感觉很简单的东西,就可以生成很强大的文档,包括类的继承关系、函数的调用关系都很清楚~~~
上述内容就是如何用doxygen写程序注释,你们学到知识或技能了吗?如果还想学到更多技能或者丰富自己的知识储备,欢迎关注亿速云行业资讯频道。
目录
推荐阅读
-
Notepad++ 插件推荐:代码折叠、语法高亮增强工具合集
-
Emacs Evil 模式:Vim 用户快速上手 Emacs 的过渡方案
-
Vim 寄存器深度解析:多缓冲区操作与复杂文本处理
-
Atom 主题切换:Material Design 与扁平化风格对比推荐
-
Lightly IDE 快捷键:Python 开发者必学的效率提升操作
-
Xcode 模拟器调试:多设备同步与性能监控技巧
-
PyCharm 代码格式化:黑魔法工具 Black 与自动规范配置
-
IntelliJ IDEA Docker 集成:微服务本地调试与镜像构建
-
VS Code Remote SSH:远程服务器开发环境搭建全流程
-
Retool 数据库连接:支持 MySQL、PostgreSQL 等多数据源配置