Clutch

How to document large JavaScript projects

How to document large JavaScript projects
Average rating: 0
(0 votes)

In his original article Erik Rose introduced some hacks for documenting large JavaScript projects. There’s nothing better than tools that simplify life and work. So how to document large JavaScript projects with fewer efforts?

In material you will find an information and some implementation examples for sphinx-js. It consumes standard JSDoc comments and tags — you don’t have to do anything weird to your source code. You just have Sphinx initialize a docs folder in the root of your project, activate sphinx-js as a plugin, and then write docs to your heart’s content using simple reStructuredText.

The author claims sphinx-js to be an excellent way to document any large JS project. Check if it so by yourself!

Also the tutorials might be found here.

Rate this article, if you like it

Thanks! You’ve rated this material!

Got a project? Let's discuss it!

*By submitting this form you agree with our Privacy Policy.

Mailing & Legal Address

Syndicode Inc. 340 S Lemon Ave #3299, Walnut CA, 91789, USA

Visiting & Headquarters address
Kyiv Sofiivska 1/2a, 01001, Kyiv, Ukraine
Dnipro Hlinky 2, of. 1003, 49000, Dnipro, Ukraine
Email info@syndicode.com
Phone (+1) 9035021111