QT Creator使用Doxygen规范注释

如需转载请标明出处：http://blog.csdn.net/itas109
QQ技术交流群：129518033

文章目录

QT Creator使用Doxygen规范注释

前言
1.Doxygen简介
2.QT Creator Doxygen插件

2.1 qtcreator-doxygen简介
2.2 qtcreator-doxygen插件安装
2.3 启动插件
2.4 qtcreator-doxygen的用法
2.4.1 直接生成注释(推荐)
2.4.2 右键生成注释(不推荐)

环境：
QT Creator : 4.0.3
VS : 2013 update 5
OS : Windows 7 64bit

前言

代码文档对于开发过程来说是非常重要的，这里采用Doxygen生成代码文档，可以展示函数说明、类库逻辑关系及检索等功能，可以极大提高团队内部的协同与效率。

1.Doxygen简介

Doxygen是用于从带注释的C ++源生成文档的事实上的标准工具，但它也支持其他流行的编程语言，如C，Objective-C，C＃，PHP，Java，Python，IDL（Corba，Microsoft和UNO / OpenOffice风格）），Fortran，VHDL，Tcl

doxygen下载地址

2.QT Creator Doxygen插件

2.1 qtcreator-doxygen简介

qtcreator-doxygen是Qt Creator的Doxygen插件，可以实现doxygen标准的注释。

qtcreator-doxygen Github

qtcreator-doxygen插件下载地址

在这里插入图片描述

注意事项：
注意下载与Qt Creator对应的版本，比如QT Creator 4.0.3对应的插件版本为v0.4.4 for Qt Creator 4.0.x/4.1.x

2.2 qtcreator-doxygen插件安装

将相应插件放到执行路径即可

Unix: ~/.local/share/data/QtProject/qtcreator/plugins
OSX: ~/Library/Application Support/QtProject/Qt Creator/plugins
Windows: %LOCALAPPDATA%\QtProject\qtcreator\plugins

2.3 启动插件

帮助 - 关于插件 - C++ - Doxygen - load(true) - 重启Qt Creator

在这里插入图片描述

2.4 qtcreator-doxygen的用法

2.4.1 直接生成注释(推荐)

方法：在类、函数、变量上一行输入 /**[Enter]

    /**[Enter]
    int a;

    /**[Enter]
    void close();

输入后自动生成相关注释

    /**
     * @brief a
     */
    int a;

    /**
     * @brief close
     */
    void close();

2.4.2 右键生成注释(不推荐)

选中所需行右键选择Document current entity选项，将会生成相应注释，当时该注意不如上节注释完整和实用。

右键结束后的结果

int a; /**< TODO: describe */

/**
 * @brief 
 *
 */
void close();

Reference：
null

觉得文章对你有帮助，可以扫描二维码捐赠给博主，谢谢！
在这里插入图片描述
如需转载请标明出处：http://blog.csdn.net/itas109
QQ技术交流群：129518033