使用Doxygen 生成帮助文档,并生成chm 格式
doxygen+VIM文档实用指南
doxygen+VIM文档实用指南for C/C/showinfo/c131849.html摘要：文档撰写是一项十分繁琐而且费力的工作，相信已经有很多人对此深感头痛。
文档生成工具的出现最大限度地帮助程序员解决了这个问题，这些工具通常可以从程序源代码自动生成文档，大大方便了文档工作。
这篇小东西主要介绍了如何用VIM和doxygen来快速生成注释，并用最少的额外劳动来完成专业水准的程序文档的过程。
仅供参考，如有雷同，纯属巧合。
关键字：doxygen vim doxygentoolkit chm dot lex CLanuageScanner补充：本文一开始是为dylan同学准备的，后来有所扩展。
本文不涉及doxygen注释的具体做法，因为可以在网上得到更多关于这方面的范例和资料。
什么是doxygen什么是VIM为什么要使用doxygen+VIM需要做什么？1) 准备工作2) 添加注释3) 配置并运行doxygen4) 编译成chm5) 一些配置选项Dot图形扩展doxygen方便扩展吗？小结什么是doxygendoxygen是一个十分好用的自由软件，是一种文档生成器，其工作机制是利用注释中的有效信息来自动生成文档。
目前doxygen的最新版是(1.5.1)，从 上可以下载最新版的doxygen。
1.5.1版的doxygen可处理的语言包括：l C/C++l Javal Pythonl PHPl ObjectiveCl IDL (Corba, Microsoft及KDEDCOP类型)l C#l D它支持以下文档格式：l HTMLl XMLl LaTeXl RTFl Unix Man Page有了doxygen的支持后，从软件代码到项目文档的转化十分简单，直接执行doxygen可执行程序就可以了。
此时doxygen会在当前目录下寻找默认的配置文Doxyfile(此文件可以手工编写，也可以借助于doxywizard生成)，并从配置文件中读入待解析的文件列表和一些设置，最后生成相应格式的文档。
DOXYGEN代码文档生成工具的使用
本文档旨在介绍 doxygen 的使用及统一代码注释，编写出符合 doxygen 要求的良好的代 码注释风格，并可以利用 doxygen 生成代码文档，提高后续维护人员维护代码的难度，并提 高代码的可读性。
本文档为基于《郑州云涌嵌入式程序规范第一版.doc》，不涉及变量命名、缩进等要求， 仅涉及注释部分的格式，指出统一风格的 Doxygen 可识别的注释格式，作为其补充和修订。
* @details
* @param[in] RTCxRTC peripheral selected, should be LPC_RTC
* @param[in] NewState New State of this function, should be:
*
- ENABLE: The time counters are enabled
可以看到程序清单 4.1 中的注释比我们通常写的代码注释多了些以“ @”开头的标记， 正是这些标记告诉 Doxygen 如何提取文档以及如何组织文档结构的。下面对这段注释进 行解释。
4.1.1 有效注释 “ /**”表示要求 Doxygen 处理这段注释，否则如果写成“ /*”或“ /****” 之类这段注释就会被忽略掉。这样就可以控制哪些注释要出现在文档中供用户阅读，哪 些注释仅仅是给代码编写者或维护者阅读。 4.1.2 定义模块 第 2 行的“ @defgroup”表示定义一个模块，语法是“ @deup RTC 实时时钟”定义了一个名为“实时时钟”的模块。模块 id 为“RTC” 模块 ID 必须使用英文，这个 ID 的作用是区分不同模块，并可供其他模块或注释引用。 下面一行是对“ RTC”模块的说明。 4.1.3 加入到模块 第 7 行“ @ingroup RTC”表示把这个注释块加入到模块“RTC”中。 4.1.4 函数注释
doxygen使用总结
doxygen使⽤总结doxygen[功能]为许多种语⾔编写的程序⽣成⽂档的⼯具。
[举例]*⽣成⼀个模板配置⽂件，模板⽂件中有详细的注释：$doxgen -g test这样，会⽣成⼀个test⽂件,1500多⾏，可以把这个⽂件做为模板编写配置⽂件。
如果之前有test那么会将原来的test备份为test.bak.模板⽂件的部分内容如下：...前⾯的内容省略...DOXYFILE_ENCODING = UTF-8# The PROJECT_NAME tag is a single word (or a sequence of words surrounded# by quotes) that should identify the project.PROJECT_NAME =# The PROJECT_NUMBER tag can be used to enter a project or revision number.# This could be handy for archiving the generated documentation or# if some version control system is used.PROJECT_NUMBER =# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)# base path where the generated documentation will be put.# If a relative path is entered, it will be relative to the location# where doxygen was started. If left blank the current directory will be used.OUTPUT_DIRECTORY =...后⾯的内容省略...*⽣成⼀个模板配置⽂件，模板⽂件中只有简单的注释：$doxygen -s -g test这⾥，我尝试并且⽐较过，如果使⽤⽣成的⽂件只200多⾏，⼏乎没有注释,只有⼏⾏分类的注释，去除了多余的注释。
visual c++ 开发文档生成工具 Doxygen 教程
简介Doxygen简介Doxygen (1)什么是Doxygen? (1)安装Doxygen (2)设定Project的doxygen组态 (2)撰写正确格式的批注 (6)制作说明文件 (11)什么是Doxygen?Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。
通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达尼号同样的辛苦。
大部分有用的批注都是属于针对函式，类别等等的说明。
所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负担。
不过，反过来说，整理文件的工作对于您来说，就是沉重的负担。
一个好的程序设计师，在写程序时，都会在适当的地方加上合适的批注。
如果，能够在撰写批注时，稍微符合某种格式，接着就可以透过一个工具程序依据程序结构及您的批注产生出漂亮的檔。
这将令许多工作繁重的程序设计师有时间多喝几杯咖啡。
Doxygen 就是这样的一个工具。
在您写批注时，稍微按照一些它所制订的规则。
接着，他就可以帮您产生出漂亮的檔了。
因此，Doxygen 的使用可分为两大部分。
首先是特定格式的批注撰写，第二便是利用Doxygen的工具来产生檔。
目前Doxygen可处理的程序语言包含：∙C/C++∙Java∙IDL (Corba, Microsoft及KDE-DCOP类型)而可产生出来的檔格式有：∙HTML∙XML∙LaTeX∙RTFUnix Man Page而其中还可衍生出不少其它格式。
如有了LaTeX 档后，就可以透过一些工具产生出PS或是PDF档案。
在多国语言的支持方面，Doxygen 目前可支持的约有2,30种。
自Doxygen 1.2.16开始支持繁体中文(这正是小弟做的好事)。
所以在目前一些Open Source 的程序文件产生器中，Doxygen 算是相当完整的一套。
linux vscode doxygen documentation generator 用法
linux vscode doxygen documentation generator 用法要在Linux上使用VSCode和Doxygen生成文档，您需要按照以下步骤进行操作：安装VSCode：首先，您需要在Linux上安装Visual Studio Code。
您可以从VSCode 官网下载适用于Linux的安装程序，并按照说明进行安装。
安装Doxygen：Doxygen是一个用于生成代码文档的工具。
您可以使用包管理器来安装Doxygen。
例如，在Ubuntu上，您可以使用以下命令安装Doxygen：sqlsudo apt-get install doxygen安装Doxygen插件：在VSCode中，您需要安装Doxygen插件来支持Doxygen文档生成。
打开VSCode，进入扩展商店，搜索Doxygen并安装它。
配置Doxygen：在VSCode中打开您的项目文件夹，并打开名为"Doxyfile"的文件（如果不存在，您可以创建一个）。
在Doxyfile中，您可以配置Doxygen的选项，例如输出格式、目录结构和生成器类型等。
生成文档：配置完成后，打开终端并导航到项目文件夹。
运行以下命令来生成文档：cssdoxygen Doxyfile这将根据Doxyfile中的配置生成文档。
6. 查看文档：生成的文档将保存在指定的输出目录中。
您可以在浏览器中打开生成的HTML文件来查看文档。
请注意，以上步骤是一般性的指导，具体细节可能因您的项目和配置而有所不同。
确保仔细阅读Doxygen和VSCode的文档，并根据您的需求进行适当的配置和调整。
Doxygen使用教程(个人总结)
简介Doxygen一．什么是Doxygen？Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。
通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注,与打捞铁达尼号同样的辛苦.大部分有用的批注都是属于针对函式,类别等等的说明。
所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负担.不过,反过来说，整理文件的工作对于您来说，就是沉重的负担。
Doxygen 就是在您写批注时，稍微按照一些它所制订的规则。
接着,他就可以帮您产生出漂亮的文档了。
因此，Doxygen 的使用可分为两大部分。
首先是特定格式的批注撰写，第二便是利用Doxygen的工具来产生文档。
目前Doxygen可处理的程序语言包含：•C/C++•Java•IDL （Corba， Microsoft及KDE-DCOP类型)而可产生出来的文档格式有：•HTML•XML•LaTeX•RTF•Unix Man Page而其中还可衍生出不少其它格式。
HTML可以打包成CHM格式，而LaTeX可以透过一些工具产生出PS或是PDF文档。
二．安装Doxygen•1。
1 安装 Doxygen 1。
7。
4(Windows）•1。
2 安装 graphviz 2。
28。
0（Windows)graphviz 是一个由AT＆T实验室启动的开源工具包，用于绘制DOT语言脚本描述的图形.Doxygen 使用 graphviz 自动生成类之间和文件之间的调用关系图，如不需要此功能可不安装该工具包。
•1。
3 安装 Windows Help Workshop 1。
32Doxygen 使用这个工具可以生成 CHM 格式的文档。
三．Doxygen的配置Doxygen 产生文档可以分为三个步骤.一是在程序代码中加上符合Doxygen所定义批注格式。
二是使用Doxywizard进行配置。
doxygen注释详解-附有生成文档的对照
使用Doxygen的目的. Doxygen所需工具. 配置Doxygen Doxygen注释风格
第一页，编辑于星期三：四点 五十六分。
使用Doxygen的目的
生成模块文档，方便以后维护模块代码。 提高代码可读性。 提高项目代码的管理。
省略了自己写readme文件（或文档）。
作符已经够我们函数用了，所以不再列举。） 特殊符号指令符：-、#、::。（这三符号对于我们也够用了）
第二十五页，编辑于星期三：四点 五十六分。
Param 指令操作符讲解
Param：指定函数参数指令操作符。 Param 格式如下：
@param 参数名 参数说明 @param [in] 参数名 参数说明
第八页，编辑于星期三：四点 五十六分。
附带操作
为了方便运行Doxygen工具与管理.为每个模块创建一文
件夹(如：“TEST”),在TEST文件夹里再创建src、doc文件夹。
Src文件夹存放源文件，doc文件夹存放Doxygen输出文件。
顺便把doxygenWD.bat和Doxygen配置文件“Doxyfile” 拷
第九页，编辑于星期三：四点 五十六分。
配置Doxygen
分为两种:
①向导(Wizard)模式：将快速配置大多数重要设定, 其他选项保持默认值。
②专家(Expert)模式：进入全部的配置选项。
第十页，编辑于星期三：四点 五十六分。
向导(Wizard)模式
向导(Wizard)对话框----Project相关选项
第二十八页，编辑于星期三：四点 五十六分。
note 指令操作符讲解
note：指定函数注意项事或重要的注解指令操作符。
note格式如下： @note 简要说明
文档生成工具——Doxygen
⽂档⽣成⼯具——Doxygen参考： 版权声明：本⽂章转载⾃Jhuster的。
未经作者允许，严禁⽤于商业出版，否则追究法律责任。
⽹络转载请注明出处，这是对原创者的起码的尊重1 简介 为代码写注释⼀直是⼤多数程序员有些困扰的事情。
更头痛的是写⽂档，以及维护⽂档的问题，⽽doxygen就能把遵守某种格式的注释⾃动转化为对应的⽂档。
Doxygen是基于GPL的开源项⽬，是⼀个⾮常优秀的⽂档系统，当前⽀持在⼤多数unix（包括linux），windows家族，Mac系统上运⾏，完全⽀持C++, C, Java, IDL（Corba和Microsoft 家族）语⾔，部分⽀持PHP和C#语⾔，输出格式包括HTML、latex、RTF、ps、PDF、压缩的HTML和unix manpage。
有很多开源项⽬（如log4cpp和CppUnit）都使⽤了doxygen⽂档系统。
2 Doxygen配置⽂件2.1 ⽣成Doxygen配置⽂件 运⾏Doxywizard创建配置⽂件。
可以直接点“Save…”按钮，将保存默认的配置⽂件，名为Doxyfile，内容是Doxygen的默认设置。
Doxyfile是普通⽂本⽂件，可以直接打开⼿动编辑。
不过在Doxywizard的界⾯上填写也很⽅便，每个参数都有详细提⽰。
建议⽤Doxywizard 完成第⼀次设置。
以后如果需要调整个别参数，可以直接编Doxyfile。
上述Doxywizard界⾯中提供了⽣成Doxygen⽂档的4个步骤，按照上述步骤⼀步步执⾏就可以⽣成漂亮的⽂档了。
第⼀步是⽣成配置⽂件，提供三种⽅式：Wizard⽅式指简约⽅式，在其中只提供⼀些重要的参数设置，其余的均为默认值；Expert⽅式为详细设置⽅式，通过该选项可以详细地配置Doxygen的各个配置项；Load⽅式，⽤于导⼊以前⽣成的Doxygen配置⽂件，导⼊后可以再点击Expert进⾏修改。
2.2 配置选项含义详解选项含义DOXYFILE_ENCODING Doxygen⽂件的编码⽅式，默认为UTF-8，若希望⽀持中⽂，最好设置为 GB2312PROJECT_NAME Project 的名字，以⼀个单词为主，多个单词请使⽤双引号括住。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
1.Download the htmlhelp.exe from website and install it. Website：/enus/library/ms669985.aspx 2. Download doxygen-1.8.0-setup.exe from website and install it. Website： http://www.stack.nl/~dimitri/doxygen/downl oad.html
4. Open HTML Help Workshop：Start->TML Help Workshop -> HTML Help Workshop. The following is the opening interface.
பைடு நூலகம்
5.Open index.hhp generated by Doxygen in HTML Help Workshop. The steps are: File->Open-> index.hhp（ index.hhp is located at the path of docs setting in Doxygen), click compile, and then get the index.chm. In default, index.chm and index.hhp will be in the same direct. Please see the following snaps:
1.Generate Code’s Notes base on the format requirement of doxygen(Programmers’ responsibility).Please see doxygen_manual.chm. Now assume the source code which have been commended is located at : C:\Users\Vincent\Desktop\include\include 2.Please open Doxygen as the following steps: GUI：Start->doxygen->Doxyziward。 The following are snapshots:
3.Set the properties. Please refer the following snapshots.
Now, the Doxygen has generated the files which are useful to make chm, such as :index.hhp， index.hhk， index.hhc *.hmtl ,etc, we can only use index.hhp to generate chm docs.