Ⅰ. 插件描述
generates javadoc compatibile comments for c++ function definitionsⅡ. 基本信息
|
Ⅲ. 安装方法
使用Vundle管理器安装
在你的.vimrc下添加:Plugin '/jdox'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall
对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。
使用NeoBundle管理器安装
在你的.vimrc下添加:NeoBundle '/jdox'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall
使用VimPlug管理器安装
在你的.vimrc下添加:Plug '/jdox'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall
使用Pathogen管理器安装
在终端中运行以下命令:cd ~/.vim/bundle
git clone https://github.com/vim-scripts/jdox
Ⅳ. 文档说明
JDOX is a vim plugin that generates javadoc compatibile comment for c++ function definitions. The main point that differs jdox from similar commenting plugins is that jdox supports comments between arguments, function name and return types.
Example:
/**
- Function: a_function
- @author Pawel Prokop
- @param str
- @param number
- @return unsigned int
- @version 1.0
*/
unsigned
int a_function ( char str, / int not_used_anymore, */ unsigned int number) {