VIM DoxygenToolkit插件的深度定制化

#原由vim

  • 新公司须要使用Doxygen格式来注释代码,格式以下
    /**
    * @fn func’s name
    * @brief func's brief comment.
    * @details Some detailed comment.
    * @param [in] param a 's comment.
    * @param [out] param b 's comment.
    * @return
    * @li
    * @author
    * @date
    */函数

  • DoxygenToolkit.vim使用以下配置 let g:DoxygenToolkit_commentType="C"
    let g:DoxygenToolkit_dateTag="@date "
    let g:DoxygenToolkit_briefTag_pre="@fn "
    let g:DoxygenToolkit_paramTag_pre="@param [] "
    let g:DoxygenToolkit_returnTag="@return "
    let g:DoxygenToolkit_authorTag="@author "
    let g:DoxygenToolkit_versionTag="@version "
    let g:DoxygenToolkit_authorName="Huang.Lin"
    let g:DoxygenToolkit_briefTag_funcName="yes"
    let g:DoxygenToolkit_compactDoc="yes" "insert white line
    let g:DoxygenToolkit_cinoptions="c0C1" " First '*' indent whitespace default=c1C1post

执行:Dox后的效果为 /**
* @fn PanelCB
* @param [] panel
* @param [] event
* @param [] callbackData
* @param [] eventData1
* @param [] eventData2
* @return
*/
已经能知足大部分的要求了,但是author和date两项还须要另外添加, 因此我就修改了DoxygenToolkit.vim来达到个人目的,改动的地方以下。spa

  • 添加author和date信息 在函数DoxygenCommentFunc中添加加亮部分的代码 修改DoxygenToolkit.vim图 这部分代码来自DoxygenAuthorFunc函数,已经有现成的代码能够借鉴了,这里只要进行简单的复制粘贴便可。code

  • 添加fn信息 在配置文件中添加以下语句 let g:DoxygenToolkit_briefTag_post="@brif " 并在如图所示出添加高亮代码便可 @brifci

  • 添加return值列表@li信息 在DoxygenCommentFunc函数中找到returned value这一项,在后面能够加入图示的代码便可完成@li项目的添加 添加@li列表it

#这样运行的结果为: 最后结果io

相关文章
相关标签/搜索