在统信uos中生成c/c++/java源码api文档,需先安装doxygen和可选graphviz,生成并配置doxyfile,再执行doxygen命令生成html文档。

在统信UOS系统中生成C/C++/Java等源码的API文档,必须先安装Doxygen工具并完成基础配置,否则无法从注释中提取结构化文档。
安装Doxygen与Graphviz
统信UOS默认未预装Doxygen,需通过终端命令安装核心工具及可选图表支持组件。
打开终端,执行以下命令安装Doxygen主程序:
sudo apt update && sudo apt install doxygen
若需生成类图、调用图等可视化图表,必须额外安装Graphviz:
sudo apt install graphviz
【Graphviz安装后必须重启终端或重新登录用户,否则doxygen配置中DOT_PATH将无法自动识别dot命令路径】
验证安装是否成功:
doxygen --version && dot -V
两条命令均应输出版本号,无报错即表示环境就绪。
生成并编辑Doxyfile配置文件
Doxygen不依赖图形界面运行,所有行为由Doxyfile文本配置文件驱动,首次使用必须生成该文件。
进入你的代码根目录(例如 ~/myproject),执行:
doxygen -g
该命令会在当前目录生成默认配置文件 Doxyfile。注意:此文件名区分大小写,不可改名。
用文本编辑器打开 Doxyfile,重点修改以下三处:
INPUT = ./src → 改为实际源码所在子目录路径,如代码在当前目录下则填 .
PROJECT_NAME = "MyProject" → 替换为你的项目名称,中文需确保系统locale支持UTF-8
GENERATE_HTML = YES → 确保此项为YES,否则不会生成网页版文档
如需生成LaTeX PDF文档,还需将 GENERATE_LATEX 设为 YES,并确认系统已安装texlive-full(UOS应用商店可搜“TeX Live”安装)。
运行Doxygen生成文档
保存 Doxyfile 后,在同一目录下直接执行:
doxygen
Doxygen开始扫描源码、解析注释、生成HTML和搜索索引。首次运行耗时取决于代码量,通常几秒到数分钟。
生成结果默认存放在 html/ 子目录中,打开 index.html 即可浏览完整文档。
若提示 “warning: character 0xXXXX cannot be represented in the current encoding”,说明源码中含非UTF-8编码注释,需用 iconv 或编辑器统一转为UTF-8再运行。
后续每次修改源码注释后,只需再次执行 doxygen 命令即可增量更新文档,无需重新配置。











