jsdoc.vim

jsdoc.vim generates JSDoc block comments based on a function signature.

This plugin based on https://gist.github.com/3903772#file-jsdoc-vim written by NAKAMURA, Hisashi

Depending on your confuguration, jsdoc.vim will prompt for description, @return type and description. It will also prompt you for types and descriptions for each function @param.

Data type tab completion supported for parameter and return types

• currently: boolean, null, undefined, number, string, symbol, object

Usage

1. Move cursor on function keyword line.
2. Type :JsDoc or <C-l> which is default key mapping to insert JsDoc.
3. Insert JsDoc above the function keyword line.

Configuration

g:jsdoc_allow_input_prompt default: 0 Allow prompt for interactive input.

g:jsdoc_input_description default: 1 Prompt for a function description

g:jsdoc_additional_descriptions default: 0 Prompt for a value for @name, add it to the JSDoc block comment along with the @function tag.

g:jsdoc_return default: 1 Add the @return tag.

g:jsdoc_return_type default: 1 Prompt for and add a type for the aforementioned @return tag.

g:jsdoc_return_description default: 1 Prompt for and add a description for the @return tag.

g:jsdoc_return_plural default: 0 Use the @returns tag instead of @return.

g:jsdoc_default_mapping default: 1 Set value to 0 to turn off default mapping of :JsDoc

g:jsdoc_access_descriptions default: 0 Set value to 1 to turn on access tags like @access <private|public> Set value to 2 to turn on access tags like @<private|public>

g:jsdoc_underscore_private default: 0 Set value to 1 to turn on detecting underscore starting functions as private convention

g:jsdoc_allow_shorthand default: 0 Set value to 1 to allow ECMAScript6 shorthand syntax.

g:jsdoc_param_description_seperator default: ' ' Characters used to seperate @param name and description.