This document shows how to enhance your documentation capabilities with VS Code.
Adding doxygen language support could be done by installing the doxygen extension.
To support you with automated comment templates in your code, the Doxygen Documentation Generator is very useful.
To install doxygen:
apt install doxygen
For enhanced visualization in doxygen, install graphviz.
apt install graphviz
To run doxygen from VS Code, the Doxygen Runner extension is helpful.
Simply install the extension, add a Doxyfile to your workspace folder (e.g. with doxygen -g) and change the settings.json accordingly.
"doxygen_runner.configuration_file_override": "${workspaceFolder}/Doxyfile"
Finally you can start doxygen via the command palette (Ctrl+Shift+P), selecting Generate Doxygen documentation.
There are several markdown related extensions available. But currently a very nice one is Markdown All in One. It supports shortcuts, automated creation of TOCs and many more.
If you like to enrich your documentation with nice UML diagrams, the PlantUML extension is the right choice. It supports you with syntax highlighting of plantUML files and a very cool preview windows that displays your diagrams during creation. To show the preview on a pure plantUML file or embedded within doxygen/markdown use the command palette (Ctrl+Shift+P) and run PlantUML: Preview Current Diagram. The diagrams could also be exported in various formats.
As mentioned, it could also be integrated with doxygen. The diagrams are automatically generated and included in your documentation then.
- Official Doxygen site: https://www.doxygen.nl/index.html
- PlantUML Website: https://plantuml.com