code documentation (not marionette's code)

[Dustin Nation]

2 parter:

1. What do people use to document their code? I've started using JSDoc3, but...meh.
2. If JSDoc3 is widely used, can someone take a crack at http://stackoverflow.com/questions/21941802/documenting-a-marionette-module-with-requirejs-and-jsdoc3 ?

Thanks guys!

Dustin

[Dustin Nation]

So thanks to some comments on SO, I got question #2 figured out. Its a bit of a learning curve to get things registered in the docs under the thing that you want registered. I even started documenting my Wreqr stuffs.  Now I have a much better handle on documenting all of my event based flow. I now feel like someone could pick up my project where I left off if I got hit by a bus :)

[Jeremy Mcleod]

One of the best things about jsdoc comments (to me) is that web storm, my JavaScript IDE of choice, can use them to provide intellisense-like code completion help. There are several plugins for jsdoc3 - I haven't seen one specifically for backbone or marionette, but I know there's one for jqueryui widgets, which present similar challenges. If you can't find one that exactly fits your needs you might be able to do the whole community a favor and use the jqueryui plugin as a basis for developing a plugin for marionette-style modules.