【Tools系列】doxygen文档系统的使用教程

DATE: 2019.9.7

前言

    在大型项目开发中，往往需要在开发程序中为函数，API接口等添加很多注释，为了方便用户使用，可以采用工具生成具有清晰的具有一定关系的文档，比如在线浏览器HTML、离线参考手册Latex文档。本文讲述采用doxygen将具有一定规范的代码注释生成文档。

1、参考

doxygen官方网站
Doxygen简介及使用说明

2、doxygen简介

Doxygen是一个开源，跨平台的程序的文档产生工具，可以将程序中的注释转换成说明文档或者说是API参考手册，从而减少程序员整理文档的时间。当然这里程序中的注释需要遵循一定的规则书写，才能让Doxygen识别和转化。

目前Doxygen可处理的程序语言包含C/C++、Java、Objective-C、IDL等，可产生出来的文档格式有HTML、XML、LaTeX、RTF等，此外还可衍生出不少其它格式，如HTML可以打包成CHM格式，而LaTe