230611-Automatic generation of project code documents through Doxygen (Mac+Win common)

background introduction

• PythonAt present, the document management of mainstream projects is mostly Sphinxrealized through;
• There are currently Sphinxno C#plugins for etc. code;
• If you want to manage C#the project code Sphinx, you can Doxygenexport it as xmla file for secondary conversion;
• There are relatively few domestic materials on Doxygenthe introduction and use of this product;
• This article introduces Doxygenthe specific steps and precautions for downloading, configuring, and installing

language support

final effect

• By UMLshowing code between classes/functions逻辑结构结构
  

• detailed 文档说明and related information
  

specification requirements

• My prompt：

Try to discuss: the importance of unified management of project documents and codes. Within 300 words, please describe the above answers in sections.

• ChatGPT Answer：

Unified management of project documentation and code is critical to project success and sustainability. Specifically, its importance is reflected in the following aspects:

1. Promote teamwork and communication

The unified management of project documents and codes can make it easier for team members to find the files they need, and avoid wasting time and energy in finding and understanding the file structure. This helps to improve the efficiency of collaboration and communication among team members, and promote the smooth progress of the project.

2. Reduce errors and conflicts

Unified management makes it easier for team members to examine a file's change history to identify and fix potential issues. This can help reduce the occurrence of errors and conflicts, and maintain the quality and schedule of the project.

3. Promote project sustainability and development

Unified management of project documents and code makes it easier for team members to maintain and update projects. In addition, if the project needs to be expanded or refactored in the future, unified management can reduce the difficulty and cost of changes and modifications, thereby promoting the sustainability and development of the project.

To sum up, the unified management of project documents and codes plays an important role in promoting team collaboration and communication, reducing errors and conflicts, and promoting project sustainability and development. It is one of the key factors for project success.

Preparation

• Download and install Doxygen: https://www.doxygen.nl/download.html
• Download and install GraphViz: https://graphviz.org/download/ (see 注意事项, pay attention to add the path to the system variable)

configuration steps

• Step 1: Download the GitHub sample code from Github
• Step 2: SetupWizard-Project

• Step 3: SetupWizard-Mode
  
• Step 4: SetupWizard-Output
  
• Step 5: SetupWizard-Diagrams
  
• Step 6: SetupExpert-Dot
  • <DOT_PATH>: The path of the bin in the graphviz installation file
  • <DAT_PATH>: The path of the bin in the graphviz installation file

• Step 7: Run

- Step 8: Show HTML

Precautions

1. How to configure and install brew on MacOS?
   • MacOS install brew_macos brew_Hanmozhidao Blog
   • Install brew on MacOS - Programmer Sought
2. To install GraphViz on Win, you need to add the corresponding path to the environment variables of the system: graphviz 1: Install graphviz bazyd
3. graphvizHow to view the installation path in MacOS ?
   

references

• YouTube Video Teaching Demo
• Zhihu video reprint + subtitles
• GitHub sample code