使用CodeBlocks编写和Doxygen生成帮助文件

下载 www.codeblocks.org

汉化

1.将\locale\zh_CN\zh_CN.mo整个文件夹拷贝到\share\CodeBlocks中
2.设置->环境设置->视图->国际化->Chinese(Simplified)

防止乱码

3.设置->编辑器 -> 常规设置 -> 编码设置->编码->utf-8
4.设置->编译器设置->其他编译器设置 写入
-finput-charset=utf-8
-fexec-charset=GBK

使用mingw-64及gdb调试显示stl类型

5.无论是编译器还是调试器，请给出可执行路径
6.调试器设置->GDB/CDB Debugger->调试器初始化命令

source D:\devtools\mingw64\bin\stl.gdb

7.进入mingw64\bin目录，新建stl.gdb文件，写入以下内容

python
import sys
sys.path.insert(0,'D:\devtools\mingw64\share\gcc-6.3.0\python')
from libstdcxx.v6.printers import register_libstdcxx_printers
register_libstdcxx_printers (None)
end

配置项目模板文件

8.项目模板 在Documents and Settings \ < user > \ Application Data \ codeblocks \ UserTemplates目录中.

9.配置默认代码
设置->编辑器->默认代码，编写时参考以下
$(WORKSPACE_NAME) 工作空间名
$(PROJECT_NAME) 项目名
$(PROJECT_DIR)  项目完整路径
$(ACTIVE_EDITOR_STEM) 当前文件名
$(ACTIVE_EDITOR_EXT) 当前文件后缀
$(ACTIVE_EDITOR_FILENAME) 当前文件完整路径
$(TODAY) 当前日期YYYY-MM-DD
$(NOW)   当前时间YYYY-MM-DD-hh.mm
$(WEEKDAY) 当前星期的英文名，例如Wednesday
$(COIN) 随机数字1或0

$(RANDOM) 随机数字

10.设置项目自定义全局变量

设置->全局变量 ->base文本框随便给个路径（如CodeBlock目录）
右边的用户自定义字段中写入名称和值，比如author = jrvzuo_qiu
此时你可以用${#default.author}定义你的默认代码了，如

/***
 * Filename: $(ACTIVE_EDITOR_STEM).$(ACTIVE_EDITOR_EXT)
 * Author: ${#default.author}
 */

11. 关于doxyBlocks插件使用

doxyBlocks插件是调用doxygen来自动生成项目帮助文件，以供后来者快速读懂之前程序员的代码。doxyBlocks功能很强，这里记录些我配置的过程。DoxyBlocks -> open preferences -> 最后的“常规”选项卡。
在此写入doxygen、doxywizard、HHC、Dot路径，前两个从官网下载最新的doxygen程序bin目录（可能要翻墙），HHC指微软的HTML Help Workshop程序目录下的hhc.exe命令行工具，Dot指Graphviz程序bin目录下的dot.exe。HHC可以将HTML文件编译成chm帮助文件，dot“所想即所得”可以将graphviz关系图代码转化成png格式的图片，这里doxyBlocks用它生成UML关系图等然后插入帮助文档。
配置好上面后，就可以生成帮助文件HTML了。但生成的index.html是英文的，而且没有生成chm格式。以下方法是本人摸索出来，可供参考，* 为必填。
确保以下工具存在后，DoxyBlocks ->DoxyWizard打开doxy配置对话框。
* Step 1的文本框中写入Doxygen工作目录，即/doxygen/bin
Step 2的Wizard选项卡->Topics->Project
* Project name中写入项目名称
Project synopsis中写入项目摘要描述
Project version or id中写入项目版本
Project log中给张项目Log图片
* Source code directory中写入源文件目录，如项目中的src文件夹
* 勾选上Scan recursively 表示递归搜索源文件目录
* Destination directory中写入生成文档的存放目录，如项目中的desc文件夹
Wizard->Topics->Mode
Select the desired extraction mode中可选生成的部分，建议All Entities生成所有部分
* Select programming language to optimize the results for中选择项目语言（doxygen支持多种语言）
Wizard->Topics->Output
勾选上HTML表示生成HTML文档，单选plain HTML表示纯HTML文档，第二个表示带有导航的HTML，第三如果要生成CHM格式文档的话必须选中。
勾选上LaTex表示生成LaTex和PDF文档
勾选上Man pages 生成man帮助文件（linux下帮助文件）
勾选上Rich Text Format及XML生成rtf和xml格式的帮助文件
Wizard->Topics->Diagrams
单选第三个表示使用graphviz生成图表，建议勾选。勾选后的复选建议全部勾选获得完整的图片文件。
Expert->Topics->Project
* 如果你使用UTF-8文件编码的话，DOXYFILE_ENCODING一定要写成UTF-8
* OUTPUT_LANGUAGE如果你用中文的话，改为Chinese
TAB_SIZE关于对齐格式，建议为4
Expert->Topics->Build 建议勾选前六个，获得完整的结构文档
Expert->Topics->Input 注意INPUT_ENCODING是否是UTF-8(否则可能乱码)
Expert->Topics->HTML 
勾选上GENERATE_HTMLHELP表示生成HTML帮助（及chm文件）
CHM_FILE 填写生成的chm文件名，注意不是路径，仅仅是文件名，如index.chm
HHC_LOCATION 给出hhc.exe程序的完整路径
CHM_INDEX_ENCODING 给出生成索引的编码，建议GBK
建议不要勾选SEARCHENGINE选项，未知错误
Expert->Topics->Dot
勾选上HAVE_DOT表示生成图表文件
建议勾选上UML_LOOK 表示生成UML关系图
DOT_IMAGE_FORMAT建议只用PNG格式
DOT_PATH 给出graphviz程序的bin目录
完成以上工作运行，成功生成文档。
如果有error: failed to run html help compiler on index.hhp的错误，尝试在管理员权限下输入：

regsvr32 "HTML Help Workshp程序目录\itcc.dll"

应该能够解决问题。