如何通过Windows命令提示符运行Doxygen生成Python代码HTML文档

操作步骤 #

• 确认Doxygen已安装，且已添加到系统PATH环境变量中（若未添加，需使用Doxygen安装路径的完整执行文件路径，例如 C:\Program Files\doxygen\bin\doxygen.exe）
• 首次使用时，生成默认配置文件：

  doxygen -g Doxyfile
  

• 编辑生成的Doxyfile文件，配置关键项（按需修改）：
  • 设置要扫描的Python代码路径：INPUT = ./your_python_code_path（替换为实际代码目录或单个文件路径）
  • 确保开启HTML文档生成：GENERATE_HTML = YES
  • 让Doxygen正确识别Python文件：EXTENSION_MAPPING = py=Python
  • 可选：指定文档输出目录：OUTPUT_DIRECTORY = ./docs
• 执行命令生成HTML文档：

  doxygen Doxyfile
  

• 生成完成后，HTML文档默认在当前目录的html子文件夹（或你指定的OUTPUT_DIRECTORY下的html文件夹），打开其中的index.html即可查看完整文档。

内容的提问来源于stack exchange，提问作者psw