使用 Doxygen 自动生成代码文档

作者 Marlous 日期 2019-02-02
Tools
使用 Doxygen 自动生成代码文档

参考：
1、 doxygen使用
2、 视频教程
3、 Doxygen简介及使用说明

一 概述

  1. 什么是 Doxygen？有什么用？
  • 注释遵循一定的规范（Doxygen），然后可以用来给自己写的代码生成文档，也能用来为分析别人写的源代码生成文档。
  • Doxygen 可以从一套归档源文件开始，生成 HTML 格式的在线类浏览器，或离线的 LATEX、RTF 参考手册。
  • 便于代码和文档保持同步。/ 可以对文档做版本管理。

  1. 支持的语言：
    完全支持 C、C++、Java、IDL、Objective-C、Python、PHP、C#、Fortran、VHDL。

  2. 输出的格式：
    直接支持 HTML、Latex、RTF、manpage、Qt help project、XML，间接支持 chm、
    Qt Compressed Help、Postcript 和 PDF。

二 使用实践

  1. 下载安装 Doxygen、Graphviz（帮助 Doxygen 生成一些图表等，不需要直接使用它）。

  2. 设置 Graphviz 的环境变量。
    设置 Graphviz 的环境变量

  3. 在自己的项目代码里按照一定的规范写注释。规范写法参考

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    e.g.

    /**
     * @brief Calculate the sum of two int.
     * 
     * This function will return the sum of two int.
     * 
     * @param a The first number.
     * @param b The second number.
     * @return int The sum of a and b.
     */
    int add(a, b)
    {
    	int sum;
    	int a,b;
    	sum = a + b;
    	return sum;
    }

  4. 使用 Doxygen GUI 来设置：

  • Doxygen 的工作目录是指用来存放配置文件的目录。/ 文档起个名字。/ 所要生成代码文档的代码目录。/ 生成的文档保存在何处。
    使用 Doxygen GUI 来设置

  • 要哪些生成文档。/ 选择自己要生成文档的语言。
    使用 Doxygen GUI 来设置

  • 生成 HTML 的文档。/ 有数学公式的话勾选 LaTeX。
    使用 Doxygen GUI 来设置

  • 生成一些图表（类图等）。
    使用 Doxygen GUI 来设置

  • 开始生成：
    使开始生成

  • 查看文档：在生成的目录中选择 index.html 来查看文档。

FEATURED TAGS
Tools