
Doxygen 1.14 便携版三分钟生成 API 文档doxywizard 向导与注释规范速成一、便携包核验Doxygen 1.14.0 官方 win64 便携 zip解压即用doxygen.exe --version实测输出1.14.0包内含图形向导 doxywizard 与 libclang从源码注释自动生成文档是行业标准做法C/C/Java/Python 等 20 语言支持大量开源项目的 API 文档出自它。二、两个入口三分钟跑通图形向导双击doxywizard.exeStep1 选工程目录Step2 勾 Scan recursivelyStep3 输出 HTMLRun 页点 Run doxygen——浏览器直接看文档。命令行doxygen-gDoxyfile# 生成默认配置# 编辑 Doxyfile: INPUT srcdoxygen Doxyfile# 产出 html/index.html建议把解压目录加入 PATH脚本里直接调用。三、注释怎么写才有效最小可用三件套覆盖日常九成场景/// 计算两点间欧氏距离/// param a 起点/// param b 终点/// return 距离值恒非负doubledistance(constPointa,constPointb);/// brief 会话管理器/// warning 非线程安全classSession{/* ... */};优先补齐的是API 边界类公有成员、全局函数、模块头文件。内部实现细节的注释价值密度低别本末倒置。四、中文输出两个开关Doxyfile 三行搞定中文配置项值作用DOXYFILE_ENCODINGUTF-8配置文件自身编码INPUT_ENCODINGUTF-8源码编码OUTPUT_LANGUAGEChinese输出界面语言源文件本身也要存 UTF-8否则注释一律乱码——这是新手第一坑。五、工程化建议Doxyfile 进版本库与代码同评审开WARN_IF_UNDOCUMENTED YES找出没写注释的公有接口当 lint 用CI 里跑 doxygen 保证文档可持续构建文档腐烂比代码腐烂更隐蔽。六、Doxyfile 关键项速查配置项推荐值说明INPUTsrc扫描目录别用默认全盘RECURSIVEYES递归子目录EXCLUDE/test//build/排除测试与构建产物WARN_IF_UNDOCUMENTEDYES公有接口缺注释当警告HAVE_DOTYES启用类图/协作图需 GraphvizEXTRACT_ALLNO只文档化有注释的实体保持干净装了 Graphviz 的再把HAVE_DOT打开类继承图、调用图自动长出来——文档站档次立刻不一样。七、文档质量怎么验收三条验收线打开html/index.html首页能看懂模块划分随机点开三个类页有完整参数说明warnings.log里 UNDOCUMENTED 警告数量逐月下降。文档不是写完就算是跟着代码活下来才算。配套完整工程Doxygen 1.14.0 代码文档生成器 Windows x64 官方便携版含向导注释规范教程成器 Windows x64 官方便携版含向导注释规范教程](https://download.csdn.net/download/achuxin123/93657047)官方便携原包含 doxywizard与图文教程都在工程包里。