Doxgen使用说明

doxgen+vim使用说明;

doxygen 是一个十分好用的自由软件,是一种文档生成器,其工作机制是利用注释中的有效信息来自动生成文档。

下载 doxygentoolkit.vim 并将其安装到 $VIMRUNTIME/plugin 目录下;

let g:doxygenToolkit_authorName ="your name"

let g:doxygenToolkit_briefTag_funcName ="yes"

map <F3>a :DoxAuthor          生成文件注释

map <F3>f :Dox                生成函数注释

map <F3>b :DoxBlock           生成程序块注释

 

进入相应目录:

doxygen -g   生成配置文件   -s不生成注释

修改相应的配置文件  Doxyfile   默认文件名称

然后doxygen 配置文件就可以生成

05-26
### 关于 Doxygen 的使用方法、教程及相关工具 #### 什么是 Doxygen? Doxygen 是一种用于自动生成软件文档的工具,能够将源代码中的注释提取并转换为各种格式的文档。它的主要特点是支持多种编程语言(如 C++、C、Java 等),并且可以生成 HTML、LaTeX、RTF、PostScript 和 PDF 等多种形式的输出[^3]。 --- #### Doxygen 的基本使用流程 1. **创建配置文件** 使用 `doxygen` 工具自带的命令生成默认配置文件: ```bash doxygen -g config_file_name ``` 这会生成一个名为 `config_file_name` 的配置文件,其中包含了 Doxygen 所需的各种参数设置[^2]。 2. **编辑配置文件** 配置文件中定义了许多选项,例如输入路径 (`INPUT`)、输出路径 (`OUTPUT_DIRECTORY`)、是否生成图形化依赖关系图 (`DOT_GRAPH`) 等。可以根据需求调整这些选项。例如: ```plaintext INPUT = ./src/ OUTPUT_DIRECTORY = ./docs/ EXTRACT_ALL = YES OPTIMIZE_OUTPUT_FOR_C = YES TYPEDEF_HIDES_STRUCT = NO ``` 3. **运行 Doxygen** 编辑完成后,执行以下命令以生成文档: ```bash doxygen config_file_name ``` 此操作会根据配置文件的内容解析指定目录下的代码,并生成相应格式的文档[^1]。 4. **查看生成的文档** 默认情况下,Doxygen 会在指定的输出目录下生成一系列文件夹,其中包括 HTML 文件和其他类型的文档。可以通过浏览器打开生成的索引页面(通常是 `index.html`)来浏览完整的文档结构。 --- #### 常见配置项解释 - **EXTRACT_ALL**: 如果设为 `YES`,则即使未加特殊标记的类或成员也会被包含到最终文档中[^4]。 - **OPTIMIZE_OUTPUT_FOR_C**: 当处理纯 C 代码时启用此选项,可以使生成的文档更加贴近 C 开发者的阅读习惯[^4]。 - **TYPEDEF_HIDES_STRUCT**: 控制 typedef 是否隐藏原始 struct 名称,默认值可能因版本不同而有所变化。 --- #### 支持的语言与特性 Doxygen 对不同的语言有不同的兼容程度。以下是其对几种主流语言的支持情况: - **C/C++**: 完全支持,适合复杂的模板和继承体系。 - **Java**: 提供 javadoc 风格的注释解析功能[^3]。 - **Python/PHP**: 虽然部分支持,但对于动态特性的描述能力有限[^3]。 --- #### 相关工具推荐 除了核心的 Doxygen 外,还有一些辅助工具可以帮助提升效率: 1. **Graphviz (dot)** Graphviz 可用来绘制 UML 类图、调用图等功能性图表。需要在配置文件中开启相关选项(如 `HAVE_DOT=YES`)。通过这种方式可以让文档更具可视化效果。 2. **Help Workshop** Windows 平台上制作 CHM 文件的一个重要组件——hhc.exe,位于 Microsoft Help Workshop 中。如果希望打包成单个帮助文件 (.chm),那么安装该程序并将 hhc.exe 添加至环境变量是非常必要的[^5]。 3. **Breathe & Sphinx** Breathe 插件允许开发者结合 Python 文档引擎 Sphinx 来构建更强大的混合型技术手册。这种方法特别适用于那些既想保留 reStructuredText 格式的灵活性又渴望自动化 API 列表的人群。 --- #### 示例:简单的 Doxyfile 设置 下面展示了一个简化版的 Doxyfile 示例,便于快速入门: ```plaintext PROJECT_NAME = "My Project" OUTPUT_LANGUAGE = English GENERATE_LATEX = NO RECURSIVE = YES FILE_PATTERNS = *.h *.cpp QUIET = YES WARNINGS = YES ``` ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值