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

布满荆棘的人生 2023-07-15 11:25 9阅读 0赞

一、下载插件

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

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

插件下载地址：[https://github.com/fpoussin/qtcreator-doxygen/releases][https_github.com_fpoussin_qtcreator-doxygen_releases]

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbGxva2FuZHk_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbGxva2FuZHk_size_16_color_FFFFFF_t_70 1][]

二、安装方式

If you downloaded a binary release, the paths are as follow:
    	Unix: ~/.local/share/data/QtProject/qtcreator/plugins/<version>
    	OSX: ~/Library/Application Support/QtProject/Qt Creator/plugins/<version>
    	Windows: %LOCALAPPDATA%\QtProject\qtcreator\plugins\<version>
    	Replace <version> 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 打上勾，然后就可以使用了。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbGxva2FuZHk_size_16_color_FFFFFF_t_70 2][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbGxva2FuZHk_size_16_color_FFFFFF_t_70 3][]

四、快捷输入

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);

[https_github.com_fpoussin_qtcreator-doxygen]: https://github.com/fpoussin/qtcreator-doxygen
[https_github.com_fpoussin_qtcreator-doxygen_releases]: https://github.com/fpoussin/qtcreator-doxygen/releases
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbGxva2FuZHk_size_16_color_FFFFFF_t_70]: /images/20230528/e7684ccdc4464205a704475396c9e7ab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbGxva2FuZHk_size_16_color_FFFFFF_t_70 1]: /images/20230528/93ca5edd7fc548d4a2900f2b23aec9be.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbGxva2FuZHk_size_16_color_FFFFFF_t_70 2]: /images/20230528/3fd95e224013407488f21b587df8b7ea.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbGxva2FuZHk_size_16_color_FFFFFF_t_70 3]: /images/20230528/fc49ba99505b43378e41ad1e8b08de9f.png