Comment section is vague, needs examples and explanations

[mimshwright]

Please add more detail to your comment section.

[borisdiakur]

There should actually exist a guidance on how to document code efficiently. Of course you can just use JSDoc style all over the place, but then you end up with something like this:

/**
 * This function does some complicated stuff
 */
function doSomeComplicatedStuff() { /* ... */ }

What we actually need is an understanding on how to describe our code so that it helps us understand it better. This would include answering questions like:

• What is the purpose of the code block?
• How does it solve the given task?
• What side effects does it introduce?
• and so on...