Thread

Arihant

Non sticky pan to events 🥘🍳

Mar 22, 2016

Which is the best JavaScript documentation tool?

I've a bunch of options to choose from

JSDoc
document.js
documentation
esdoc

JSDoc doesn't have a very explicit documentation, I'm struggling there. Document.js is the best in terms of documentation, but it doesn't support some es6 features. documentation is sorta extension of JSDoc generator with the same comment structure, I don't find it useful given I have JSDoc generator. I haven't tried esdoc yet. Suggestions please?

#documentation #javascript #jsdoc

Responses(2)

Denny Trebbin

Lead Fullstack Developer. Experimenting with bleeding-edge tech. Irregularly DJ. Hobby drone pilot. Amateur photographer.

Mar 22, 2016

We are not using code documentation generators anymore since we switched to Gitlab. Because in Gitlab the code is searchable and syntax highlighting is also available. Beside Gitlab, all editors and IDEs have good search features. We have no demand anymore for browsing code documentation. Learn how to use by study unit tests and browse the Git history.

Thanks for the reply @fibric ! But I'm working on a team that is making a framework, I want the documentation generator for api level exposure methods. I didn't know about gitlab until you mentioned it. Would gitlab solve that case too ?

Dong Nguyen

Web Developer

Mar 22, 2016

ESDoc, just use it.

Arihant

Non sticky pan to events 🥘🍳

Mar 22, 2016

What should be the metrics in favor of ESDoc instead of JSDoc? Apologies, I haven't looked much into ESDoc, I'm trying to avoid some documentation reading here...

@gdad-s-river: I said that because ESDoc is only documentation generator tool I've used :)

Search Hashnode

Which is the best JavaScript documentation tool?

Responses(2)

Recent threads