Hi!
Keryx Web:
1. Is JSDoc not a good idea? If so, why not?
It's a good idea, but it's not nearly as useful as JavaDoc. I think
there are problems arising from the degree to which JavaScript is a
dynamic language.
2. If it is, why has it not caught on?
"Real programmers" with experience of automated documentation tools
don't care about writing JavaScript. Front-end developers are often not
used to set up build script that strips out comments for production code
or generate documentation and the like.
In a situation today where we use more and more complex JavaScript
solutions I think the need for good JavaScript documentation increases.
References:
http://jsdoc.sourceforge.net/
This project is building a JS documentor in JS on top of the Mozilla
Rhino engine:
http://code.google.com/p/jsdoc-toolkit/
I have tried both for documenting some of my code, see:
http://nornix.sourceforge.net/jsapi/
http://nornix.sourceforge.net/jsapi2/
Both get some things badly wrong. I have tweaked both code and comments
to help them out, but the question is if that is a good way to use my
time :-)
/AndersN
*******************************************************************
List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm
Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm
Help: [EMAIL PROTECTED]
*******************************************************************
