Hello and welcome to our community! Is this your first visit?
Register
Enjoy an ad free experience by logging in. Not a member yet? Register.
Results 1 to 3 of 3
  1. #1
    New to the CF scene
    Join Date
    Jan 2005
    Posts
    7
    Thanks
    0
    Thanked 0 Times in 0 Posts

    documentation from source for javascript

    Is there such a thing as an API documantation generator for javascript, like what javadoc is to java?

    Ive found some 'generic' source to html converters, but these just extract comments, and the code Ive been handed has very few of these, and they wont tell me what calls what.

    Rolling my own may be an option.

  • #2
    Regular Coder
    Join Date
    Aug 2004
    Location
    codegoboom@yahoo.com
    Posts
    999
    Thanks
    0
    Thanked 0 Times in 0 Posts
    I thought about trying these out, but never did...

    ...lemme' know if they work!
    *this message will self destruct in n-seconds*

  • #3
    Senior Coder
    Join Date
    Feb 2004
    Location
    Edinburgh
    Posts
    1,352
    Thanks
    0
    Thanked 0 Times in 0 Posts
    JSDoc looks good and is probably worthwhile on large projects, but can also see it being overkill on smaller projects. i work as a "view developer" on a J2EE project and obviously Javadocs are invaluable when looking up bean properties, etc. likewise a JS documentation tool like JSDoc would be good for documenting the JS used throughout the system. nonetheless, I couldn't see it being worthwhile on anything other than an application. a website would just not need that kind of documentation.
    *keep it simple (TM)


  •  

    Posting Permissions

    • You may not post new threads
    • You may not post replies
    • You may not post attachments
    • You may not edit your posts
    •