I thought about this myself. I like the idea since this would document our code as well as create the html docs.
This has two downsides however: 1) In Java you can afford to comment your source as much as you like, because the compiler strips out the comments, and your comments don't affect the file size and performance of the byte code. In JavaScript however we have to be conscious of the size of our source comments, as they are not striped out before they are downloaded. Thus this effects performance 2) You have to build a doc compiler. This is a project of its own. I don't think we have the resources for that. NanoFace =;^) -----Original Message----- From: Matt Fair [mailto:[EMAIL PROTECTED]] Sent: November 14, 2001 4:39 PM To: Laszlo Teglas Cc: [EMAIL PROTECTED] Subject: RE: [Dynapi-Dev] Documentation Project Are we thinking of puting together source documentation like what java has with its javadocs? A javadoc style would be: /** I put my documentation here for this method example: foo bar */ FooBar.prototype.foo=function() { ... } We could put together a web-based documentation compiler. just some thoughts. Matt _______________________________________________ Dynapi-Dev mailing list [EMAIL PROTECTED] http://www.mail-archive.com/dynapi-dev@lists.sourceforge.net/
