Is there any specific tool that is used by underscore authors to generate documentation? I suppose so because I've found at least three projects documented in the same style, but I can't find any information about such tool used by any of those projects.
Asked
Active
Viewed 342 times
3
-
I don't know if there is, but backbone.js and underscore.js were both created by the same person ([Jeremy Ashkenas](http://ashkenas.com/)). – Jack Jun 26 '14 at 20:33
-
Probably it's just the same html template. Or Jeremy Ashkenas use some engine to generate static html. Like jekyll or something similar.. – rcarvalho Jun 27 '14 at 00:23
1 Answers
5
In contrast with the previous answer, I'm pretty sure they don't use jsDoc. Jeremy Ashkenas is the creator also of Docco, and you can still see Underscore documented with docco. But the main documentation seems to be using something else, and it's not jsDoc. The evidence is clear: Look a the source code and there's no jsDoc tags!
More than that, it's also clear that the documentation is generated entirely externally to the source code itself. If you examine http://underscorejs.org/#chaining, you will see that it includes the text "When you've finished the computation," but a search of the git repo for "the computation" finds no hits.
Ashkenas has some relationship with DocumentCloud, and I don't know much about them, but I'm guessing that something about their advertised document annotation capabilities are in play here. But I really don't know.
I wish I did, as I like the Underscore/Backbone documentation better than many others, and I have a project that's getting popular but really needs some decent documentation more than just the Docco we have now.
Scott Sauyet
- 49,207
- 4
- 49
- 103