Ⅰ. 插件描述
A Vim plugin to generate JsDoc commentⅡ. 基本信息
|
Ⅲ. 安装方法
使用Vundle管理器安装
在你的.vimrc下添加:Plugin 'scheakur/vim-jsdocy'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall
对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。
使用NeoBundle管理器安装
在你的.vimrc下添加:NeoBundle 'scheakur/vim-jsdocy'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall
使用VimPlug管理器安装
在你的.vimrc下添加:Plug 'scheakur/vim-jsdocy'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall
使用Pathogen管理器安装
在终端中运行以下命令:cd ~/.vim/bundle
git clone https://github.com/scheakur/vim-jsdocy
Ⅳ. 文档说明
jsdocy.vim
JsDocy helps you to generate comments for JsDoc.
You can use this like the followings:
:JsDocyAddJsDocFor example, if the cursor is placed on the first line of the following code
and you execute :JsDocyAddJsDoc,
function foo(bar, baz, qux) {
// some code
}then you get the result as below.
/**
* @param {} bar
* @param {} baz
* @param {} qux
* @return {}
*/
function foo(bar, baz, qux) {
// some code
}