Natural Docs: Better Javascript Doc
I’ve been contemplating a javadoc style javascript documentation tool for a while. Not to write myself but rather to go find one because you just know they’re out there. Well, here’s one posted recently on Ajaxian. It looks pretty slick, but I’m curious about how well it deals with a broader context. Sure, it’ll parse a single js file and dump out some nice looking documentation (awesome), but what about an environment that relies on code from several libraries? Can you link across them? Can you collect them? I need to dig into it some more, but it’s a start.
Does anyone have any experience or knowledge of any other javadoc systems for javascript?
via ajaxian:
Jesse Kuhnert (or Dojo/Tapestry fame) wrote to us pointing to Natural Docs.
Using the utility from http://naturaldocs.org and about 10-15 minutes of slight adjustment to my javascript comments I was fairly easily able to produce this.
Keep in mind that this is only a very small sampling of the Tapestry javascript library, but it looks like a promising utility for many javascript libraries out there. It even has dhtml tooltips + searching :)
Time for some better docs?

Leave a Reply