---

Ⅰ. 插件描述

Generate JSDoc block comments in vim.

Ⅱ. 基本信息

创建日期：  2016-02-06 使用用户：  14 Github星：  1 插件作者：  Joe Gesualdo

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'joegesualdo/jsdoc-vim'

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

:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'joegesualdo/jsdoc-vim'

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

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'joegesualdo/jsdoc-vim'

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

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/joegesualdo/jsdoc.vim

Ⅳ. 文档说明

## JSDoc Vim

Generate JSDoc block comments in vim.

Demo

Install

Vundle

Vundle is the recommended installation method

Add to your plugin list:

Plugin 'joegesualdo/jsdoc.vim'

Once added you your plugin list, you must install the plugin.

Launch vim and run:

:BundleInstall

Or install from command line:

$ vim +PluginInstall +qall

Usage

You can execute the JSDocAdd() function directly within a buffer. But it's
recommended you add a mapping.

How to call function directly.

Call the function while cursor is on first line of a function definition:

:call JSDocAdd()

How to call from mapping

Define the mapping in your .vimrc.

nnoremap jsd :<C-u>call JSDocAdd()<CR>

Now while cursor is on first line of a function definition, you can call
the mapping.