使用 Doxygen 生成源码文档

Doxygen 是一个开源跨平台的，以类似 JavaDoc 风格编写软件参考文檔的工具

Getting started

创建配置文件

`doxygen -g &lt;config-&lt;span class="hljs-built_in">file&lt;/span>&gt;`

运行 doxygen

`doxygen &lt;config-&lt;span class="hljs-built_in">file&lt;/span>&gt;`

项目名称

`&lt;span class="hljs-attr">PROJECT_NAME&lt;/span> = My Project`

项目简介

`&lt;span class="hljs-attr">PROJECT_BRIEF&lt;/span> = What a project`

项目 Logo

`&lt;span class="hljs-attr">PROJECT_LOGO&lt;/span> = src/images/logo.png`

主页面

`&lt;span class="hljs-attr">USE_MDFILE_AS_MAINPAGE&lt;/span> = README.md`

文档的语言

`&lt;span class="hljs-attr">OUTPUT_LANGUAGE&lt;/span> = Chinese`

指定需要生成文档的文件，以空格分割

`&lt;span class="hljs-attr">INPUT&lt;/span> = ./src`

排除的文件

`&lt;span class="hljs-keyword">EXCLUDE&lt;/span> = .&lt;span class="hljs-regexp">/src/&lt;/span>Demo`

写入文档的路径

`&lt;span class="hljs-attr">OUTPUT_DIRECTORY&lt;/span> = ./docs`

是否搜索子目录

`&lt;span class="hljs-attr">RECURSIVE&lt;/span> = &lt;span class="hljs-literal">YES&lt;/span>`

标记指定一个或多个通配符模式

`&lt;span class="hljs-attr">EXCLUDE_PATTERNS&lt;/span> = */node_modules/*`

即使各个类或函数没有文档，也要提取信息

`&lt;span class="hljs-attr">EXTRACT_ALL&lt;/span> = &lt;span class="hljs-literal">YES&lt;/span>`

是否记录私有成员

`&lt;span class="hljs-attr">EXTRACT_PRIVATE&lt;/span> = &lt;span class="hljs-literal">YES&lt;/span>`

是否包含静态成员

`&lt;span class="hljs-attr">EXTRACT_STATIC&lt;/span> = &lt;span class="hljs-literal">YES&lt;/span>`

生成一个搜索框

`&lt;span class="hljs-attr">SEARCHENGINE&lt;/span> = &lt;span class="hljs-literal">YES&lt;/span>`

点工具

`&lt;span class="hljs-attr">HAVE_DOT&lt;/span> = &lt;span class="hljs-literal">YES&lt;/span>`

指定 graphviz 的路径

`DOT_PATH`

HTML

`&lt;span class="hljs-keyword">GE&lt;/span>&lt;span class="hljs-symbol">NERATE_HTML&lt;/span>`

HTML 帮助编译器

`&lt;span class="hljs-keyword">GE&lt;/span>&lt;span class="hljs-symbol">NERATE_HTMLHELP&lt;/span>`