[code comment] Doxygen

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

Download address .

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 .