- 浏览: 679529 次
- 性别:
- 来自: 北京
文章分类
- 全部博客 (181)
- Matlab (16)
- Java (26)
- autoHotkey (4)
- openCV (1)
- C++ (50)
- PDF-XChange Viewer (2)
- 学术 (11)
- javascript (4)
- linux (11)
- SWT (9)
- latex (7)
- GAE (2)
- windows (6)
- C# (3)
- PS (20)
- JNI (4)
- latex,批处理 (0)
- 批处理 (4)
- Android (5)
- 矩阵论 (1)
- SVM (1)
- 概率图模型 (0)
- Python (12)
- Eigen (5)
- 编程题 (1)
- MKL (1)
- 神经网络 (9)
- 最优化 (2)
- 摄影 (1)
- PPT (0)
- After Effects (3)
- CUDA (3)
- caffe (0)
- MXNet (2)
- svn (1)
- R (0)
- 虚拟机 (0)
- tensorflow (7)
- theano (1)
- Keras (1)
- vim (1)
- xgboost (1)
- spark (6)
- eclipse (2)
- word2vec (0)
- hadoop (1)
- dmlc (1)
- git (0)
最新评论
-
jeffersonz:
请问大神,这个插件记录下来的脚本为什么不能再Extendscr ...
PhotoShop - 记录PS的所有操作为JavaScript代码 -
cherishLC:
Andy__Zou 写道cherishLC 写道Andy__Z ...
Eigen的编译选项;MKL的使用 -
Andy__Zou:
cherishLC 写道Andy__Zou 写道cherish ...
Eigen的编译选项;MKL的使用 -
cherishLC:
Andy__Zou 写道cherishLC 写道Andy__Z ...
Eigen的编译选项;MKL的使用 -
Andy__Zou:
cherishLC 写道Andy__Zou 写道 您好,您的工 ...
Eigen的编译选项;MKL的使用
示例程序、配置文件及doxygen常见参数文字版参见本文附件
先来看下生成html格式的文档:
1、下载&安装
http://www.stack.nl/~dimitri/doxygen/download.html
下载完了双击安装,你懂的
2、生成并修改配置文件
如下命令将在当前目录下生成一个 “Doxygen.config”的配置文件;配置文件基本是通用的,只是工程名什么的需要适当修改
3、修改配置文件
当你生成的文档中中文全是乱码,不知你会作何感想?于是乎,配置文件还是得自己动手改改的!
配置文件就是一文本,如下图所示:
各种选项啊!!!以下挑出来一些进行了修改(重要的用红色标出),修改时请善用编辑器的查找选项~
4、生成文档
命令行下的一句命令而已:
也可以在visual studio中配置外部工具如下(假设配置文件在solution的doc目录下):
5、文档规范
有前置注释和后置注释两种,其中后置注释放在变量后面,要在开头加一个<号。
示例如下(详尽的注释规范参见最后给出的官方文档链接):
6、其他链接
注释规范官方文档(更全):http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
文档中可用的特殊命令(@param之类的):http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdsee
文档中嵌入html代码:http://www.stack.nl/~dimitri/doxygen/manual/htmlcmds.html
主页上显示说明:http://www.stack.nl/~dimitri/doxygen/manual/faq.html
先来看下生成html格式的文档:
1、下载&安装
http://www.stack.nl/~dimitri/doxygen/download.html
下载完了双击安装,你懂的
2、生成并修改配置文件
如下命令将在当前目录下生成一个 “Doxygen.config”的配置文件;配置文件基本是通用的,只是工程名什么的需要适当修改
doxygen -g Doxygen.config
3、修改配置文件
当你生成的文档中中文全是乱码,不知你会作何感想?于是乎,配置文件还是得自己动手改改的!
配置文件就是一文本,如下图所示:
各种选项啊!!!以下挑出来一些进行了修改(重要的用红色标出),修改时请善用编辑器的查找选项~
4、生成文档
命令行下的一句命令而已:
doxygen Doxygen.config
也可以在visual studio中配置外部工具如下(假设配置文件在solution的doc目录下):
5、文档规范
有前置注释和后置注释两种,其中后置注释放在变量后面,要在开头加一个<号。
示例如下(详尽的注释规范参见最后给出的官方文档链接):
#pragma once //就是示例代码,我也忘不了你啊 /** *@file *@brief 文件的简介,必须以英文句点结尾. *该文件的详细介绍。 每个文件都应该有这种文件介绍,否则该文件注释居然就是代码。。。其他注释也被省略了 */ /**类的简明注释以英文句号结尾. * 我是类的详细注释啊详细注释 */ class ExampleForDoxygen { int size;///< 放在变量后面的简明注释,注意需要一个小于号表示注释是后置注释 public: ///方法的简明注释,出现在方法列表中 int getSize(); ///方法简明注释,方法2: /**方法详细注释,只出现在方法的具体介绍中*/ static inline int getLeftChildIndex (int index /**<[in]参数注释也可以后置哦,用方块内的in表明是输入参数*/,int outParm /**<[out]输出参数*/,int index /**<[inout]输出输出参数*/); /** 简明注释以英文句号结尾. 我是详细注释啊详细注释 *@param index [in]参数注释,这种方法下写in貌似不行啊 *@return 返回值注释 *@see getLeftChildIndex //参见列表 */ static inline int getParentIndex (int index) ; };
6、其他链接
注释规范官方文档(更全):http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
文档中可用的特殊命令(@param之类的):http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdsee
文档中嵌入html代码:http://www.stack.nl/~dimitri/doxygen/manual/htmlcmds.html
主页上显示说明:http://www.stack.nl/~dimitri/doxygen/manual/faq.html
发表评论
-
C++函数中的静态变量
2019-07-19 11:22 763在C++中,可以在成员函数中使用静态变量,从而间接达到在hpp ... -
tensorflow 静态编译笔记 -- linux系统
2018-11-05 14:26 0注: 1、编译tensorflow静态库 很简单,参见: h ... -
gperftools笔记
2018-06-27 14:30 0export LD_LIBRARY_PATH=LD_LIBR ... -
dmlc分布式线性模型编译笔记
2018-06-06 10:37 21061、使用第三方修改后的wormhole工程 原始工程wor ... -
C++中读取控制台输出,并将文件指针FILE*转换为istream
2017-11-27 15:03 1708解决的问题: 1、通过执行系统的bash命令后,获取其输出( ... -
c++中使用boost库在共享内存中存储map
2017-11-09 11:37 5122boost库中的interprocess包可以在共享内存中创建 ... -
近似最近邻算法库FLANN
2017-04-25 18:45 0FLANN库是计算近似最近邻的库, 问题定义如下: 给定距离函 ... -
C++杂记-- 重定向std::cout等
2017-04-18 17:28 18891、屏蔽std::cout 参见:http://stackov ... -
CMake指定目标代码的平台(win32,x64)
2016-06-03 20:54 11534主要参考自:http://blog.c ... -
windows 10下安装GPU版MXNet
2016-06-03 21:28 8529上回说到编译CPU版的MXNet: http://cheris ... -
windows下安装CPU版mxnet
2016-05-23 23:14 17489MXnet (mix net)类似Caffe,Tensorfl ... -
Linux C++编译及 静态/动态 链接库 笔记
2015-12-20 19:49 59861、C++文件的编译 g++参 ... -
Linux (Ubuntu) 下 Eclipse C++ 环境配置
2015-12-08 21:49 19201、安装JDK 参见http://blog.csdn.net/ ... -
Photoshop插件开发-filter
2015-10-11 22:53 3311初学,,感觉PS插件的文档很烂,,教程也很少,,也就这么简单学 ... -
使Visual Assist X支持CUDA的.cu文件的代码提示
2015-07-17 00:05 2228现在安装CUDA很方便了,直接支持Visual Studio。 ... -
CUDA程序block和thread超出硬件允许值时的异常
2015-07-13 11:32 3681调用CUDA的核函数时指定block 和 thread大小,该 ... -
创建及使用DLL
2014-09-29 15:22 1194此篇仅作简要的记录,作为备忘。 更为详细的可以参考:http: ... -
matlab的mexFunction中使用std::cout(部分转载)
2014-09-27 15:37 2124在matlab、C++混合编程的时候,可能会用到之前的代码。代 ... -
Eigen库:那些年我们一起经历的bug
2014-09-24 18:39 17711、使用auto声明新变量 ... -
C++:无虚函数的类作为有虚函数类的父类时产生Expression:_BLOCK_TYPE_IS_VALID(pHead->nBlockUse)
2014-09-24 09:48 1900调程序时忘了为啥,写了一小段测试程序,再简单不过,结果跑出了E ...
相关推荐
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTML...
这是十分流行的C++文档生成工具,java有javadoc,C++也有doxygen,通过一点技巧,就可以生成非常漂亮的HTML的文档。当然,有时候,你会觉得这个工具做的东西有些冗余。但是它还是省去了许多麻烦。
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTML...
doxygen帮助文档生成工具,c++、java可以使用相同注释规范,然后生成帮助文档
doxygen 可以为 c,c++,java 等语言写的程序生成文档(从程序的源代码中提取其中按照约定格式写的 注释中提取信息)。查看 doxygen 的 man 手册,翻译如下: 许多使用 doxygen 的方法: 1)使用 doxygen 生成一个配置...
可自动自动生成C/C++,Java,C#开发文档. 类说明,函数说明,类继承关系图.
可自动自动生成C/C++,Java,C#开发文档. 类说明,函数说明,类继承关系图.
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以从一套归档源文件开始,生成...
doxygen最新全套资源,包含英文和中文文档,使用帮助,举例windows下使用doxygen生成c/c++APi文档,结合其他软件生成带有结构图的文档。
Doxygen是可用于C++、 C、 Java、 Objective-C、 Python、 IDL (Corba 和 Microsoft flavors)以及部分PHP、 C#和 D语言的文档系统。 它能通过以下三种方式帮助你: 1,它能从一系列源文件中生成在线浏览文档...
doxygen 是一种用于 C/C++、Java™、Python 和其他编程语言的文档系统,生成HTML格式的在线类浏览器 doxygen可以提取在源代码中的注释,并分析将此转换成HTML文档,也可以当做手册使用,功能很强大
文档生成器,能够自动生成C++、JAVA等语言的文档
doxygen window 版,适用于32 ,64位操作系统,doxgen用于代码文档生成,支持c++, java...
最新版doxygen(window版),适用于32 ,64位操作系统,doxgen用于代码文档生成,支持c++, java...。软件介绍,编码规范等。包含doxygen-1.9.1-setup.exe、简介、安装及使用、doxygen讲解、doxygen注释语法。
Doxygen可以从C,C++, java等源代码中提取消息来生成帮助文档, API资料等
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以从一套归档源文件开始,生成...
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTML...
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以从一套归档源文件开始,生成...