Doxygen

++ Doxygen

开始学习 Doxygen

+++安装
ubuntu下安装太简单了
sudo apt-get install doxygen doxygen-doc doxygen-gui
+++使用
代码中需要按照一定的注释格式,才能给doxygen来生成
否则就是一片空白

++++vim
DoxyGen Syntax : DoxyGen Highlighting on top of c/c++/java
http://www.vim.org/scripts/script.php?script_id=5

vim的插件,貌似可以用来生成 Doxygen 格式的注释

.vimrc做如下设置:
let g:DoxygenToolkit_authorName="朱一凡, vermiliondun@gmail.com"
let s:licenseTag = "Copyright(C)\<enter>"
let s:licenseTag = s:licenseTag . "For 朱一凡\<enter>"
let s:licenseTag = s:licenseTag . "All right reserved\<enter>"
let g:DoxygenToolkit_licenseTag = s:licenseTag
let g:DoxygenToolkit_briefTag_funcName="yes"
let g:doxygen_enhanced_color=1

"F1添加文件头注释
au FileType cpp map <F1> :DoxAuthor<CR>
au FileType python map <F1> :DoxAuthor<CR>
"F2添加函数注释
au FileType cpp map <F2> :Dox<CR>
au FileType python map <F2> :Dox<CR>
"所有权
au FileType cpp map <F3> :DoxLic<CR>
au FileType python map <F3> :DoxLic<CR>

在文件最开始,按下F1则自动添加文件头注释
光标在函数上按下F2,则自动取出函数参数等,形成函数注释(只有在头文件的函数中添加,才能被DoxyGen捕捉到)
其他地方也可以按下F2,生成说明注释
文件最末尾按下F3,则生成版权信息
+++生成
doxygen-gui
Expert选项中,选择output_language为chinese
input中,根据代码的编码格式,选择input_encoding为utf-8或者GBK
选择路径啥的,生成html