---

Ⅰ. 插件描述

Generate Doxygen Comment Skeleton

Ⅱ. 基本信息

创建日期：  2003-06-12 使用用户：  1 Github星：  1 插件作者：  Leif Wickland

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin '/makedoxygencomment'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle '/makedoxygencomment'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug '/makedoxygencomment'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/vim-scripts/MakeDoxygenComment

Ⅳ. 文档说明

I haven't maintained this in a long time.  I'd suggest trying out Ryan De Boer's updated version: vimscript #4530.

Generates a doxygen comment skeleton for a C, C++,  or Java function, including @brief, @param (for each named argument), and @return.  The tag text as well as a comment block header and footer are configurable.  (Consequently, you can have brief, etc. if you wish, with little effort.)

It's definitely a little rough around the edges, but I hope you find it useful.

To use:  In vim with the cursor on the line of the function header that contains the parameters (if any), execute the command :Dox.  This will generate the skeleton and leave the cursor after the @brief tag.

Limitations:
Assumes that the function has a blank line above it and that all of the parameters are on the same line.  
Not able to update a comment block after it's been written.
Writes the @return tag for a void function.

Example:
Given:
int foo(char mychar, int yourint, double myarray[])
{ //...
}

Issuing the :Dox command with the cursor on the function declaration would generate

/**

• @brief
• @param mychar
• @param myint
• @param myarray
  *
• @returns
  **/