最近尝试了doxygen,还是很好用的,我在mac和linux下都进行了尝试。效果都不错。现在把使用的方法记录下下来,给自己使用。
我自己的使用的情况主要是配合vim进行使用的,所以我还选择了相应的插件DoxygenToolKit.vim,该插件还是挺容易上手的。
linux下安装一下软件
sudo apt-get install doxygen
sudo apt-get install doxygen-gui
sudo apt-get install graphviz
完成后运行doxywizard 就可以进行相应的配置,选择相关的代码之后进行操作。
mac就更简单了,有doxygen.dmg大概是这个名字吧,在doxygen官网上有下载。
但是安装了这些软件之后还是不能直接使用的,需要给文件添加一些必要的注释,否则不能输出。所以DoxygenToolKit插件就产生了,通过进行配置可以生成相应的注释。
注:在多次尝试之后发现,修改一些变量之后,导出的文档的质量会下降,比方说原来可以直接显示为参数,但是修改后变成了text,所以我除了添加函数头,和author的赋值之外,其他没有做配置。
效果不错。
以下是网上找来的配置的代码,大家可以酌情使用。
let g:DoxygenToolkit_briefTag_funcName="yes"
map <leader>da :DoxAuthor<CR>
map <leader>df :Dox<CR>
map <leader>db :DoxBlock<CR>
map <leader>dc a <LEFT><LEFT><LEFT>
let g:DoxygenToolkit_briefTag_funcName = "yes"
" for C++ style, change the '@' to '\'
"let g:DoxygenToolkit_commentType = "C++"
let g:DoxygenToolkit_briefTag_pre = "brief "
let g:DoxygenToolkit_templateParamTag_pre = "tparam "
let g:DoxygenToolkit_paramTag_pre = "param "
let g:DoxygenToolkit_returnTag = "return "
let g:DoxygenToolkit_throwTag_pre = "throw " " @exception is also valid
let g:DoxygenToolkit_fileTag = "file "
let g:DoxygenToolkit_dateTag = "date "
let g:DoxygenToolkit_authorTag = "author "
let g:DoxygenToolkit_versionTag = "version "
let g:DoxygenToolkit_blockTag = "name "
let g:DoxygenToolkit_classTag = "class "
let g:DoxygenToolkit_authorName = "zhuanghj"
let g:doxygen_enhanced_color = 1
"let g:load_doxygen_syntax = 1
let g:DoxygenToolkit_blockHeader="/****************************************************************************"
let g:DoxygenToolkit_blockFooter="****************************************************************************/"
let g:DoxygenToolkit_startCommentTag = ""
let g:DoxygenToolkit_interCommentTag = "*"
let g:DoxygenToolkit_endCommentTag = ""
let g:DoxygenToolkit_startCommentBlock = ""
let g:DoxygenToolkit_interCommentBlock = "* "
let g:DoxygenToolkit_endCommentBlock = ""