在QtCreator中使用doxygen

Posted WeyneChen

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了在QtCreator中使用doxygen相关的知识,希望对你有一定的参考价值。

  接触Doxygen后,认识到其强大之处,一口气将之前的烂代码重构了一遍,所有的文件头,函数注释等等都是手动添加注释。在keil中可以看到其对JavaDoc风格的注释有高亮,非常好看。但是keil这个IDE作为编译器和调试工具,好用的没话说,作为编辑器却非常不能与时俱进。自动补全,代码缩进都超烂。找了很多编辑器,像sublime,Atom,VS code等,又缺少跨文件的补全,go to definition等功能。vim和emacs学习曲线又太长。同事提到可以试试Qt Creator看看,于是我们一起试了试。发现真的可行。另外还有惊喜,就是发现Qt对Doxygen的支持非常好。

  首先,Qt提供了doxygen注释的高亮,如下图:

  然后,我还有一堆代码要重构,一点点添加注释实在太费时间,就想有没有自动化的方法。最开始想到的是使用Qt Creator的片段功能。

后来在翻设置选项时,又发现了这个

Qt Creator自带了一个 doxgen注释功能。于是百度之,发现了有一个自动添加 doxygen注释的插件(http://dev.kofee.org/projects/qtcreator-doxygen/)。可是插件在3.1版本后就不再更新了,我用的是3.5版本。这么好的插件怎么可能就不更新了呢?于是继续查找,发现了这个(http://wiki.qt.io/Doxygen_Plugin_for_QtCreator)

大概意思是,若是没有插件的二进制档,那么就得下载Qt Creator的源码和插件源码自己编译了。怎么弄,我又参考了另外一篇文章,http://www.devbean.net/2011/08/qtcreator-plugin-develop-2/。

不过目前还没有编译成功。

以上是关于在QtCreator中使用doxygen的主要内容,如果未能解决你的问题,请参考以下文章

使用 LLVM 在 Windows 上的 QtCreator 编译中没有创建目标的规则

使用 cmake 部署 QtCreator

使用MinGW编译Qt Creator

如何在 Linux 的 QTCreator 中使用 dlopen 打开的共享库中设置断点

将 QtCreator 2.7.0 与 OpenCV 2.4.5 一起使用

在一个 QtCreator 版本中使用 cmake 构建失败,而它与另一个版本以及来自终端的 catkin_make 一起使用