vim doxygentoolkit

目前为止已经定义了doxygentoolkit 用途:
1. 快速生成许可注释,并且标签可以被修改;
2. 快速生成作者声明框架,标签可修改;
3. 快速为C/C++、Python函数或者类生成注释框架,此框架包含的元素有:@brief, @param(为每一个参数生成一个@param)和@return。标签文本和注释块的头和尾都可以修改(因此,你可以有自己的简介,如果你原义,加上一点成就);
忽 略在#ifdef...#endif(C/C++)块中代码碎片。给块命名的时候一定要考虑到其功能。在所有文件中,所有有联系的块将会放在一个新的块 DOX_SKIP_BLOCK(或者用户定义的名称)。你需要使用当前的新块名更新你的doxygen配置文件中的PREDEFINED变量。而且你还需 要将ENABLE_PREPROCESSING设置为YES。

doxygentoolkit 下载地址:http://www.vim.org/scripts/script.php?script_id=987

wget http://www.vim.org/scripts/download_script.php?src_id=14064

mv download_script.php\?src_id\=14064 DoxygenToolkit.vim


下载后安装:

install details
Copy DoxygenToolkit.vim to your '~/.vim/plugin' directory

然后编辑配置文件:

vim ~/.vimrc

我设的是:

"doxygen toolkit 
let g:DoxygenToolkit_briefTag_pre="@synopsis  "
let g:DoxygenToolkit_paramTag_pre="@param "
let g:DoxygenToolkit_returnTag="@returns   "
let g:DoxygenToolkit_blockHeader="--------------------------------------------------------------------------"
let g:DoxygenToolkit_blockFooter= "--------------------------------------------------------------------------"

let g:DoxygenToolkit_licenseTag="GPL 2.0"
let g:DoxygenToolkit_authorName="xyz, wbzhui@gmail.com"
let s:licenseTag = "Copyright(C)\<enter>"
let s:licenseTag = s:licenseTag . "For free\<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

看了下它的命令,常用的也就是两个:
光标在函数上,用 :Dox 自动生成函数的说明。
光标在文件头,用 :DoxAthor 自动生成文件说明。

分别使用DoxLic、DoxAuthor、Dox命令自动生成,注释的样式和文字完全可配置,在vimrc中添加即可。生成完注释,可以结合doxygen 自动生成各种格式的文档。




描述:

4. 快速生成一个注释集(开始或者结尾),标签可修改;
使用:
4.1 注释类型(C/C++/// 或者, Python:##和#):
在vim中,默认C++注释为,但是如果你更喜欢使用///,只需要在你的配置文件.vimrc中添加如下语句:
let g:DoxygenToolkit_commentType="C++"。

4.2 许可:
在vim中,将光标放在将要写doxygen许可注释的那一行,然后, 执行命令:DoxLic这将会生成许可注释并将光标放置在刚才那一行之后。

4.3 作者: 
在vim中,将光标放在想要添加doxygen作者注释的地方。 然后执行命令:DoxAuthor这将会生成一个框架,如果没有为其设置变量则将光标放置在@author标签之后,或者放在在框架之后。

4.4 函数/类注释:
在vim中,将光标放置在函数头部那一行(或者函数的返回变量)或者类。 然后执行命令:Dox这将生成框架并且将光标放置在@brief标签后。

4.5 忽略代码片段(只有C/C++):
在vim中,如果你想要忽略所有在块中的代码片段,类似:                 #ifdef DEBUG ... #endif 你只需要执行以下命令: DoxUndoc(DEBUG)!

4.6 组:
在vim中,执行命令: DoxBlock在后面的行中插入一个doxygen块。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值