使用 Doxygen 生成源碼文檔

Doxygen 是一個開源跨平臺的，以相似 JavaDoc 風格編寫軟件參考文檔的工具

Getting started

建立配置文件

doxygen -g <config-file>

運行 doxygen

doxygen <config-file>

Configuration

項目名稱

PROJECT_NAME = My Project

項目簡介

PROJECT_BRIEF = What a project

項目 Logo

PROJECT_LOGO = src/images/logo.png

主頁面

USE_MDFILE_AS_MAINPAGE = README.md

文檔的語言

OUTPUT_LANGUAGE = Chinese

指定須要生成文檔的文件，以空格分割

INPUT = ./src

排除的文件

EXCLUDE = ./src/Demo

寫入文檔的路徑

OUTPUT_DIRECTORY = ./docs

是否搜索子目錄

RECURSIVE = YES

標記指定一個或多個通配符模式

EXCLUDE_PATTERNS = */node_modules/*

即便各個類或函數沒有文檔，也要提取信息

EXTRACT_ALL = YES

是否記錄私有成員

EXTRACT_PRIVATE = YES

是否包含靜態成員

EXTRACT_STATIC = YES

生成一個搜索框

SEARCHENGINE = YES

點工具

HAVE_DOT = YES

指定 graphviz 的路徑

DOT_PATH

Output Formats

HTML

GENERATE_HTML

HTML 幫助編譯器

GENERATE_HTMLHELP

Special Commands

• brief
• details
• param
• return
• note

Showcase

generator-modation 腳手架的源碼文檔