V
V
Vadim2018-09-12 22:53:13
JavaScript
Vadim, 2018-09-12 22:53:13

How to set up automatic commenting of functions and methods?

Good day. From time to time, on the web, there are code examples in which there is a comment like this before each function:

/**
* This test method
* var string $foo foo
* @param1 integer This status of user
*/

describing that a function with such and such a name takes such and such arguments and returns such and such a value.
Interested, first of all, as it is called. If this is exclusively an IDE feature, then which ide has such a feature. Is there any plugin for the famous VSCode/Atom/Sublime editor and is it possible to do this by running through some npm package.
Any information is welcome. Thanks in advance!
UPD:
VS Code plugin for semi-automatic generation of comments in JSDoc style: Document it
Automatic generation of documentation in HTML/Markdown based on JSDoc comments: https://documentation.js.org/

Answer the question

In order to leave comments, you need to log in

2 answer(s)
N
napa3um, 2018-09-12
@MrDecoy

usejsdoc.org
https://ru.wikipedia.org/wiki/JSDoc

S
Sergey, 2018-09-12
@gangstarcj

In PHPStrom: Code => Generate => PhpDoc blocks

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question