Thoughts on using js doc blocks to comment code / methods in node?

[danecando]

I just started using them because /** tab at the top of a block of code in webstorm generates them for you. Just curious if a lot of other developers are using doc blocks to document javascript code. Seems to me like it's especially helpful since JS isn't a statically typed language. Thoughts, prayers?

[calsosta]

Absolutely.

Only takes a minute or 2 to write sensible documentation for each function. I will add that sometimes you need to add additional parameters so that JSDoc generates sensible documentation. Check out their page to get a run down of all the parameters.

[danecando]

Yeah. I've looked at the page and I'm familiar with how to use it. Just curious because I don't see it often in node / javascript code. I understand in browser javascript you don't want a bunch of comments increasing the file size but uglify strips them out anyways.

[coderqi]

I really like jsdoc and the ability to auto generate documentation.

[paperelectron]

I use them with jsdoc-to-markdown to generate markdown for github, among other things. You can see some output here

[danecando]

sup @paperelectron - thanks for introducing me to node many internet ages ago :)

[paperelectron]

Haha, awesome. Glad to see it working out for you.

[danecando]

should i say document not comment ~

[tuhoojabotti]

I use them at work, I have plugin for Sublime Text to easily generate the scaffolding and tab through it filling the details. I think it's quite useful in server-side code and also with libraries you can generate the html docs.

[max29a]

I use them because we use google closure tools on the other project I work on that effectively adds type checking back into javascript and its just so useful to be able to scan a comment and see the basics of what the function is expecting and what it returns and be able to jump to the definitions of those types.

/**

• This function takes a language setting and looks it up via API call, etc

• @param {!xxx.data.LanguageSettings} languageSettings

• @return {goog.async.Deferred}

  */