当前位置:网站首页>[code comment] Doxygen
[code comment] Doxygen
2022-06-09 09:18:00 【White embedded】
1. Preface
I can't understand the uncommented code after a period of time. Here is a comfortable code annotation tool .
2. download
open vscode, Search in the application market doxygen.

3. Operation introduction
3.1 Head note
At the head of the file , Input /** after , Press enter .


3.2 Function Comments
At the head of the function , Input /** after , Press enter .
stay @brief Then fill in the function .
4. adopt doxygen Generating documentation
Can pass doxygen Applications generate documents , Make it easy for others or yourself to consult .
4.1 Download and install
Install after download is complete , Enter all the way .
4.2 To configure
4.2.1 Configuration Engineering


4.2.2 Configure code extraction and optimization mode

4.2.3 Configuration file output

4.2.4 Configure the drawing scheme

4.3 Generating documentation
Click the run button , I found that there was a wrong report , The reason is that the previously selected path contains Chinese .
Change the source file to another path , Places that do not contain Chinese .
After the document is generated successfully , You can see two more folders .
If in 4.2.3 Selected RTF If it's an option , There will be one more folder , It's quite detailed Word file .
Document effects ( Try not to select the icon when configuring the project , Display more harmonious ):
5. At the end
doxygen There are many options for configuration , You can try different options to see the effect .
边栏推荐
猜你喜欢

Application of acrel bus intelligent lighting control system in hospital

The fire door monitoring system carries out 24-hour real-time automatic inspection on the status of the fire door

Open application for "cloud native technology application and practice" demonstration course project in Colleges and Universities

深度解析:二十五岁做软件测试前景怎么样?
![[redis learning 13] redis builds master-slave cluster, sentinel cluster and partition cluster](/img/e9/c0911d31dc348e1f1f9c67935ce923.png)
[redis learning 13] redis builds master-slave cluster, sentinel cluster and partition cluster

使用Canvas画出多个多边形Polygon

环境变量Path误删除
![[texstudio] [3] relatively complete paper typesetting template and bib file reference method](/img/ba/160b236aaf0fc905609b8a70c7677d.jpg)
[texstudio] [3] relatively complete paper typesetting template and bib file reference method

安科瑞综合能效管理系统在数据中心的应用

HVV blue team points north
随机推荐
MySQL basic subquery exercise
Database problems MySQL
MySQL基础 查询语句
远程预付费管理系统帮助物业解决收费难统计难问题
The fire door monitoring system carries out 24-hour real-time automatic inspection on the status of the fire door
剖析虚幻渲染体系(15)- XR专题
Esp32 learning notes [WiFi network] - 03tcp server server connection
Clickhouse data type sorting of system operation and maintenance series
neo4j访问浏览器时报错:ServiceUnavailable: WebSocket connection failure. Due to security constraints in your
Open application for "cloud native technology application and practice" demonstration course project in Colleges and Universities
dotnet core 也能协调分布式事务啦!
Linux在线安装一个Neo4j图数据库
FreeRTOS task notification review
In depth analysis: what is the prospect of doing software testing at the age of 25?
Wechat applet obtains user information and updates it
2022-2028 global social finance industry research and trend analysis report
AtCoder Beginner Contest 252
Configuring the environment for RMAN backups_ Configure the deletion policy for archived redo logs
2022-2028 global online code learning industry research and trend analysis report
MySQL基础 DML与DDL学习
