cd

coc-docthis

JSDoc extension for coc.nvim that generates detailed JSDoc comments for TypeScript/JavaScript files.

Showing:

Popularity

Downloads/wk

8

GitHub Stars

15

Maintenance

Last Commit

2mos ago

Contributors

3

Package

Dependencies

0

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

coc-docthis

JSDoc extension for coc.nvim that generates detailed JSDoc comments for TypeScript/JavaScript files, fork from vscode-docthis.

Install

:CocInstall coc-docthis

Commands

  • docthis.documentThis: generate document at current position

Configurations

configurationdescriptiondefault
docthis.returnsTag@returns tagtrue
docthis.includeAuthorTagadd the @author tagfalse
docthis.authorNamewhen docthis.includeAuthorTag, will add @author tag with this value''
docthis.includeDateTagadd the @date tag in YYYY-MM-DD formatfalse
docthis.dateTagFormatset date formatYYYY-MM-DD
docthis.includeTypestype information is added to comment tagstrue
docthis.includeMemberOfOnClassMembersmemberOf information is added to comment tags on class memberstrue
docthis.includeMemberOfOnInterfaceMembersmemberOf information is added to comment tags on interface memberstrue
docthis.includeDescriptionTagJSDoc comments for functions and methods will include @descriptionfalse
docthis.enableHungarianNotationEvaluationhungarian notation will be used as a type hintfalse
docthis.inferTypesFromNamesuse names of params & methods as type hintsfalse
docthis.includeExtraLineAfterDescriptionadd empty line after description and before other tagstrue

License

MIT


This extension is created by create-coc-extension

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100