cpp_doxygen


Ⅰ. 插件描述

Add Doxygen templates and fold Doxygen comments.

Ⅱ. 基本信息

创建日期:  2015-06-04
使用用户:  1
Github星:  2
插件作者:  Brendan

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:
Plugin '/cpp-doxygen'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:
NeoBundle '/cpp-doxygen'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:
Plug '/cpp-doxygen'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:
cd ~/.vim/bundle
git clone https://github.com/vim-scripts/cpp_doxygen

Ⅳ. 文档说明

This plugin lets you add a Doxygen comment template with a couple of key strokes. Just position your cursor on the first line of a file, namespace, class, struct, or function; then press <Leader>d. The plugin will deduce what is being commented and insert a Doxygen comment above it, ready for you to fill in. The plugin can deduce template parameters, function parameters, and return types.

The plugin also provides a function you can use to generate fold text for a Javadoc or Qt style Doxygen comment. If you call this function from your own fold text function, Doxygen comments fold up to to the brief description inside comment tokens:
    /* This a brief description. /
or
    /! This is a brief description. /

For complete details, install the plugin and run :help cpp_doxygen.

For feature requests or bugs, please create an issue at https://github.com/brobeson/Tools/.

I've tested this with Vim 7.4 on Linux (Kubuntu 15.04). Other platforms and versions of Vim should work.

添加新评论