Studio内如何使用强大的Doxgen文档生成功能【使用技巧】

发布于 2021-06-26 10:41:25 浏览：4189 订阅该版

1. 首先大家需要将这2个zip包下载下来  
https://github.com/anb0s/eclox/releases/download/eclox-0.12.1/org.gna.eclox.doxygen.site-1.8.13-SNAPSHOT.zip

[org.gna.eclox.site-0.12.1-SNAPSHOT.zip](https://oss-club.rt-thread.org/uploads/20210626/2844357b14d2b00bc44333a260a8c210.zip) 
 
![image.png](https://oss-club.rt-thread.org/uploads/20210626/76ed3eff211f9be54817e1f9cbb29550.png)  
2. 打开studio的安装新软件窗口，先安装org.gna.eclox.site-0.12.1-SNAPSHOT.zip，然后安装org.gna.eclox.doxygen.site-1.8.13-SNAPSHOT.zip  
![image.png](https://oss-club.rt-thread.org/uploads/20210626/5a0efcf60f8dc6d917ba4f84516036b1.png)  
![image.png](https://oss-club.rt-thread.org/uploads/20210626/32ac9ab9ac2ee5f46df7f14f394d933a.png.webp)  
![image.png](https://oss-club.rt-thread.org/uploads/20210626/80a1dcba507768a818025ed741749be7.png)  
注意每安装完一个都要重启一次studio再安装下一个  
![image.png](https://oss-club.rt-thread.org/uploads/20210626/6fbf9e22a59ab4c5214dc9ae80380641.png)

![image.png](https://oss-club.rt-thread.org/uploads/20210626/a28c9c444393dfc8a647c051f7f56d9f.png.webp)  
![image.png](https://oss-club.rt-thread.org/uploads/20210626/55ae789e288dcac572395df9e4b3a705.png.webp)

以上两个zip包安装完后就可以在studio上看到doxygen按钮了  
![image.png](https://oss-club.rt-thread.org/uploads/20210626/65195bcfad7cc74467f5009133fc93b3.png)

用一个DoflySTM32F103的RT-Thread开发板工程测试一下，直接点击doxygen按钮会自动搜索工程下Doxyfile并自动根据配置生成doxygen代码文档  
![image.png](https://oss-club.rt-thread.org/uploads/20210626/525edcabbb23af8e8f6b1148250871c8.png)  
![image.png](https://oss-club.rt-thread.org/uploads/20210626/24a653137242925ac07cf528a0d4fcf8.png)  
如果提示找不到dexygen配置一下首选项，利用先前安装内置的doxygen程序    
![image.png](https://oss-club.rt-thread.org/uploads/20210626/285df419893aea32fee5469f5596e422.png.webp)
构建完成后即可在对应doc文件夹下找到生成的文档，有各种形式pdf，html等等  
![image.png](https://oss-club.rt-thread.org/uploads/20210626/52b4a8a3aeb19f972ccc7a183272403a.png.webp)

关于如何使用doxygen写代码注释可以在网上搜具体学习资料进行了解，用上doxygen从此不再为写代码文档发愁，大家可以尝试下哦！

相关文章：
[Stduio如何选择只编译部分文件【使用技巧】](https://club.rt-thread.org/ask/article/2834.html)
[Studio内如何使用强大的Doxgen文档生成功能【使用技巧】](https://club.rt-thread.org/ask/article/2853.html)