I personally wouldn't use it for production websites because it inflates the size of the Javascript file, therefore forcing the user to download more. Also it would tempt others to steal code by making it easy to understand.
As a way of documenting code during development and for future reference it would be useful, but well written code should be self-documenting (well named functions) and easy to understand. On 7/25/07, Keryx Web <[EMAIL PROTECTED]> wrote:
Hi all! I have been wondering about the (absent) standard for documenting JavaScript: JSDoc. In PHP one can expect any seasoned developer to use PHPDocumentor (or something similar, like Doxygen). In JAVA one would expect Javadoc to be used by most. However, except for Foundations of Ajax (ISBN 1-59059-582-3) I see *no* other book on the market using or promoting the use of JSDoc. And as far as I know YUI is the only major library to use it. "Gurus" like David Flanagan, John Resig, Christian Heilmann, Dean Edwards and PPK are all silent on this matter, and do not use JSDoc in any code I've seen them write. Admittedly they write a lot, but JSDoc are absent from their books and blogposts, at least. 1. Is JSDoc not a good idea? If so, why not? 2. If it is, why has it not caught on? Coming to JS from a back-end developer perspective I find this very strange. Lars Gunther P.S. References: http://jsdoc.sourceforge.net/ http://en.wikipedia.org/wiki/JSDoc ******************************************************************* List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: [EMAIL PROTECTED] *******************************************************************
-- Ben Wong e: [EMAIL PROTECTED] w: http://blog.onehero.net ******************************************************************* List Guidelines: http://webstandardsgroup.org/mail/guidelines.cfm Unsubscribe: http://webstandardsgroup.org/join/unsubscribe.cfm Help: [EMAIL PROTECTED] *******************************************************************
