QT Creator 如何使用 Doxygen 规范代码注释

一、下载插件

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

源码下载地址：https://github.com/fpoussin/qtcreator-doxygen

插件下载地址：https://github.com/fpoussin/qtcreator-doxygen/releases

根据QT Creator的版本，选择相应版本的插件下载：

 

二、安装方式

If you downloaded a binary release, the paths are as follow:
	Unix: ~/.local/share/data/QtProject/qtcreator/plugins/
	OSX: ~/Library/Application Support/QtProject/Qt Creator/plugins/
	Windows: %LOCALAPPDATA%\QtProject\qtcreator\plugins\
	Replace  with your Qt Creator version (ie: 4.8.0)

将 Doxygen-0.4.4-qtc4.0.x.dll 拷贝到

D:\Qt\Qt5.7.0\Tools\QtCreator\lib\qtcreator\plugins 目录下，

 

三、启用插件

重启qt creator，在菜单的【帮助】栏选择【关于插件】找到Doxygen 打上勾，然后就可以使用了。

四、快捷输入

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

/**
 * @brief DllMain
 * @param hInstance
 * @param dwReason
 * @return 
 */
bool WINAPI DllMain( HINSTANCE hInstance, DWORD dwReason, LPVOID /*lpvReserved*/ )

4.2、鼠标右键生成注释

选中所需行右键选择Document current entity选项，将会生成相应注释

/**
 * @brief 
 *
 * @param version
 */
void doxygenTest(int version);