源碼文檔生成工具Doxygen的安裝和使用

Doxygen 是一個文件生成工具,可以將程序中的特定註釋轉換成為說明文檔,可以減少程序撰寫文檔的時間。文本介紹的方法是基於vscode 和ubuntu。

1. 安裝doxygen: sudo apt install doxygen

2. 在vscode中安裝Doxygen Documentation Generator插件

3. 在源代碼中添加註釋

4. 生成默認配置文件 doxygen –g

5. 修改配置文件Doxyfile中HAVE_DOT為NO,修改RECURSIVE為YES

6. 生成說明文檔doxygen Doxyfile

源碼文檔生成工具Doxygen的安裝和使用


分享到:


相關文章: