20_doxygen：win下vscode自动注释、生成doc

文章目录

• • 1.结果如图
  • 2.win
  • • 2.1设置目录
    • 2.2设置源码语言
    • 2.3设置输出doc
    • 2.4设置Graphviz路径
    • 2.5运行，生成doc
  • 3.VScode
  • • 3.1注释自动补全
    • 3.2生成doc
  • 参考

1.结果如图

自动注释

生成doc

2.win

安装doxygen：下载链接

安装graphviz：下载链接

graphviz 用于绘制DOT语言脚本描述的图形。Doxygen 使用 graphviz 自动生成类之间和文件之间的调用关系图。参考自此

win下能够使用GUI界面，doxywizard

2.1设置目录

2.2设置源码语言

2.3设置输出doc

2.4设置Graphviz路径

2.5运行，生成doc

3.VScode

3.1注释自动补全

安装Doxygen Documentation Generator扩展

输入/**后按Enter自动生成格式化注释

在setting中配置注释的默认信息、格式，如Author作者信息配置

3.2生成doc

前置：win下已安装doxygen，已用doxywizard生成了Doxyfile（doxywizard生成doc成功以后，在设置的工作目录下就有Doxyfile）

安装Doxygen Runner扩展

在setting中配置Doxyfile路径、doxygen.exe路径

Ctrl + Alt + P执行Generate Doxygen documentation生成doc

或 View Doxygen documentation阅览doc

参考

• Doxygen Documentation Generator
• Doxygen Runner
• windows下Doxygen的配置与使用

希望能帮助到朋友们，欢迎批评指正！

本文来自互联网用户投稿，文章观点仅代表作者本人，不代表本站立场，不承担相关法律责任。如若转载，请注明出处。 如若内容造成侵权/违法违规/事实不符，请点击【内容举报】进行投诉反馈！