doxygen使用手记

doxygen,一个从代码自动生成文档的小工具,很多类库的官方文档都是用它生成的
之前以为它和CVS一样神秘,很难用
今天试了试,真的是再简单易用不过了
doxygen 的window 版可以从
ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.3.9.1-setup.exe
下载到。linux版一般系统安装盘上就有
使用方式
到你的源代码的目录下
输入
doxygen -g
它会自动生成一个名为Doxyfile的配置文档
然后输入
doxygen Doxyfile即可(也可以直接输入 doxygen)
写代码的时候遵循现有的那些通用的c++规范就行了,唯一要注意一点的就是写注释的时候
要以///开头,而不是以前的//
因为我们通常有个习惯,//来注释掉暂时不用的代码
呵呵,当然,doxygen的功能相当丰富,更多的更详细的配置,就需要慢慢学了
当然,它有图形界面,但是我不喜欢用,速度还没有命令行快

此博客中的热门博文

少写代码,多读别人写的代码

在windows下使用llvm+clang

tensorflow distributed runtime初窥