Comments on: jsDoc - a javadoc implementation for javascript http://clientside.cnet.com/best-practices/organizing-code/jsdoc-a-javadoc-implementation-for-javascript/ Making stuff work on the other side of the request. Fri, 04 Jul 2008 14:09:21 +0000 http://wordpress.org/?v=2.0.4 by: Morganizeit http://clientside.cnet.com/best-practices/organizing-code/jsdoc-a-javadoc-implementation-for-javascript/#comment-24008 Sat, 22 Dec 2007 14:46:55 +0000 http://clientside.cnet.com/best-practices/organizing-code/jsdoc-a-javadoc-implementation-for-javascript/#comment-24008 I like the documentation artifacts produced by NaturalDocs, but the lack of IDE support is frustrating. I've been using ScriptDoc for all my own documentation because it has IDE support in the Eclipse IDE. This javadoc-like syntax is supported by both Aptana and JSEclipse. I haven't found any IDEs or editors that can display NaturalDoc notes during code completion, and once you have a taste of context sensitive documentation you'll really miss it. NaturalDocs is written in Perl. Technically it should be possible to use it to generate ScriptDoc, but my Perl foo is very weak and I gave up. I'm planning to make another attempt to do it by hand... I burned three hours last time and gave up in frustration. Maybe a regular expression based solution would do the job, but my regex foo is also weak. I like the documentation artifacts produced by NaturalDocs, but the lack of IDE support is frustrating. I’ve been using ScriptDoc for all my own documentation because it has IDE support in the Eclipse IDE. This javadoc-like syntax is supported by both Aptana and JSEclipse.

I haven’t found any IDEs or editors that can display NaturalDoc notes during code completion, and once you have a taste of context sensitive documentation you’ll really miss it.

NaturalDocs is written in Perl. Technically it should be possible to use it to generate ScriptDoc, but my Perl foo is very weak and I gave up. I’m planning to make another attempt to do it by hand… I burned three hours last time and gave up in frustration. Maybe a regular expression based solution would do the job, but my regex foo is also weak.

]]>