• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

Software for Documenting and Analysing Javascript Code

 
Ranch Hand
Posts: 226
1
jQuery Postgres Database Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi

I have just completed my first draft javascript app , which is a bit of super app at ~3500 lines with some pretty terse. I now want to refactor and document the code for efficiency and maintainability.

Are there any freely available tools for this? Are there any standards practices for doing this?

I would be particularly interested in a tool similar to some IDE javadoc tools to document existing code, but I may be dreaming here.

I will use JSLint as a quality check, but i don't think JSLint documents the code.

Any advice appreciated, thanks

Marten

 
author
Posts: 15385
6
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
There is really nothing that does what you are after.

Also warning about JSLInt, if you follow everything it says, you can slow down your application.

Eric
 
marten koomen
Ranch Hand
Posts: 226
1
jQuery Postgres Database Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
OK Thanks, I didn't think so - and JavaScript seems so much more expressive than say Java which would make a javadoc like tool ultra complex

Nothing like hard work on these things anyway - and if its automated its no longer work.

Cheers

Marten
 
Eric Pascarello
author
Posts: 15385
6
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
There are projects out there where people recreated JavaDocs as JSDoc, google search will show it. I personally have never use them and I code JavaScript for a living.

Eric
 
Your mother was a hamster and your father was a tiny ad:
a bit of art, as a gift, that will fit in a stocking
https://gardener-gift.com
reply
    Bookmark Topic Watch Topic
  • New Topic