paip c++ doxygen 文档工具的使用以及跟QT CREATOR的集成_综合

分享一下我老师大神的人工智能教程！零基础，通俗易懂！http://blog.csdn.net/jiangjunshow

也欢迎大家转载本篇文章。分享知识，造福人民，实现我们中华民族伟大复兴！

paip. c++ doxygen 文档工具的使用以及跟QT CREATOR的集成

作者Attilax ， EMAIL:1466519819@qq.com
来源：attilax的专栏
地址：http://blog.csdn.net/attilax

doxygen 文档例子:
/
/**
@file
@brief like 360 start menu button
@note 详细注释
@bug arg timer ,should hook window
@todo heyeug hookwind yaozwl .
@author attilax <1466519819@qq.com>
@date c925

文件头注释@file
//
因为文件不在任何东西里面，所以不能像类、函数等在上方放注释，只能用@file方式定义，其格式如下,一般@file后面为空,表示本文件.

2、简要注释和详细注释
///
@brief 简要注释
@note 详细注释

3.类,函数注释
///
类,函数注释分别写在类,函数的上方就好..

4.3.5 类成员变量定义示例

只在头文件的定义处进行简要注释，不要详细注释。可以在
上方用/** @brief some brief description */
或右方用///< some brief description
（1）在成员变量上面加注释的格式
/** 成员变量描述 */
int m_Var;
（2）在成员变量后面加注释的格式
int m_color; /**< 颜色变量 */

5.跟QT CREATOR的集成
//
QT CREATOR>>tool>>external>>config ,,加了个D:/doxygen/bin/doxygen.exe 参数"D:\doxygen\bin\Doxyfile4c++.cfg"但是,..不执行..提示doxygen.exe 在执行,实际不执行...使用个process monitor查看累挂..doxygen.exe没见执行..好像QT有BUG了

只好建立了个.bat....在把这个C:\Documents and Settings\Administrator\桌面\c920\doxygen.bat加到个扩展里面.走ok兰..

qt的扩展实际保存地址是 C:\Documents and Settings\Administrator\Application Data\QtProject\qtcreator\externaltools\*.xml
虽然也修改这个QtCreator.ini文件了,不过是根据externaltools\*.xml自动生成
C:\Documents and Settings\Administrator\Application Data\QtProject\QtCreator.ini
OverrideCategories\SpecialEmptyCategoryForUncategorizedTools\1\Tool=doxygen
OverrideCategories\SpecialEmptyCategoryForUncategorizedTools\2\Tool=New_Tool
OverrideCategories\SpecialEmptyCategoryForUncategorizedTools\3\Tool=attilaxc925

参考
doxygen注释语法（一）：JavaDoc注释风格、文件头和类注释 - 可乐鸡翅 - 博客频道 - CSDN.NET.htm
Doxygen详细介绍 - Timmy_zhou的专栏 - 博客频道 - CSDN.NET.htm
Doxygen - 老孙的博客 - 博客频道 - CSDN.NET.htm
使用doxygen为C C++程序生成中文文档（上）.htm
Doxygen簡介.htm

给我老师的人工智能教程打call！http://blog.csdn.net/jiangjunshow

你好！这是你第一次使用 **Markdown编辑器** 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章，了解一下Markdown的基本语法知识。

新的改变

我们对Markdown编辑器进行了一些功能拓展与语法支持，除了标准的Markdown编辑器功能，我们增加了如下几点新功能，帮助你用它写博客：

全新的界面设计 ，将会带来全新的写作体验；
在创作中心设置你喜爱的代码高亮样式，Markdown 将代码片显示选择的高亮样式 进行展示；
增加了 图片拖拽 功能，你可以将本地的图片直接拖拽到编辑区域直接展示；
全新的 KaTeX数学公式 语法；
增加了支持甘特图的mermaid语法¹ 功能；
增加了 多屏幕编辑 Markdown文章功能；
增加了 焦点写作模式、预览模式、简洁写作模式、左右区域同步滚轮设置 等功能，功能按钮位于编辑区域与预览区域中间；
增加了 检查列表 功能。

功能快捷键

撤销：Ctrl/Command + Z
重做：Ctrl/Command + Y
加粗：Ctrl/Command + B
斜体：Ctrl/Command + I
标题：Ctrl/Command + Shift + H
无序列表：Ctrl/Command + Shift + U
有序列表：Ctrl/Command + Shift + O
检查列表：Ctrl/Command + Shift + C
插入代码：Ctrl/Command + Shift + K
插入链接：Ctrl/Command + Shift + L
插入图片：Ctrl/Command + Shift + G

合理的创建标题，有助于目录的生成

直接输入1次#，并按下space后，将生成1级标题。
输入2次#，并按下space后，将生成2级标题。
以此类推，我们支持6级标题。有助于使用TOC语法后生成一个完美的目录。

如何改变文本的样式

强调文本 强调文本

加粗文本 加粗文本

标记文本

~~删除文本~~

引用文本

H₂O is是液体。

2¹⁰ 运算结果是 1024.

插入链接与图片

链接: link.

图片:

带尺寸的图片:

当然，我们为了让用户更加便捷，我们增加了图片拖拽功能。

如何插入一段漂亮的代码片

去博客设置页面，选择一款你喜欢的代码片高亮样式，下面展示同样高亮的 代码片.

// An highlighted block var foo = 'bar';

生成一个适合你的列表

项目
- 项目
  - 项目

项目1
项目2
项目3

计划任务
完成任务

创建一个表格

一个简单的表格是这么创建的：

项目	Value
电脑	$1600
手机	$12
导管	$1

设定内容居中、居左、居右

使用:---------:居中
使用:----------居左
使用----------:居右

第一列	第二列	第三列
第一列文本居中	第二列文本居右	第三列文本居左

SmartyPants

SmartyPants将ASCII标点字符转换为“智能”印刷标点HTML实体。例如：

TYPE	ASCII	HTML
Single backticks	`'Isn't this fun?'`	‘Isn’t this fun?’
Quotes	`"Isn't this fun?"`	“Isn’t this fun?”
Dashes	`-- is en-dash, --- is em-dash`	– is en-dash, — is em-dash

创建一个自定义列表

Markdown

Text-to- HTML conversion tool

Authors

John

Luke

如何创建一个注脚

一个具有注脚的文本。²

注释也是必不可少的

Markdown将文本转换为 HTML。

KaTeX数学公式

您可以使用渲染LaTeX数学表达式 KaTeX:

Gamma公式展示 $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ 是通过欧拉积分

$\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.$

你可以找到更多关于的信息 LaTeX 数学表达式here.

新的甘特图功能，丰富你的文章

ganttdateFormat  YYYY-MM-DDtitle Adding GANTT diagram functionality to mermaidsection 现有任务已完成               :done,    des1, 2014-01-06,2014-01-08进行中               :active,  des2, 2014-01-09, 3d计划一               :         des3, after des2, 5d计划二               :         des4, after des3, 5d

关于 甘特图 语法，参考这儿,

UML 图表

可以使用UML图表进行渲染。 Mermaid. 例如下面产生的一个序列图：:

这将产生一个流程图。:

关于 Mermaid 语法，参考这儿,

FLowchart流程图

我们依旧会支持flowchart的流程图：

关于 Flowchart流程图 语法，参考这儿.

导出与导入

导出

如果你想尝试使用此编辑器, 你可以在此篇文章任意编辑。当你完成了一篇文章的写作, 在上方工具栏找到 文章导出 ，生成一个.md文件或者.html文件进行本地保存。

导入

如果你想加载一篇你写过的.md文件或者.html文件，在上方工具栏可以选择导入功能进行对应扩展名的文件导入，
继续你的创作。

mermaid语法说明 ??
注脚的解释 ??