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

相關文章
相關標籤/搜索