Forum Discussion
chrisb
11 years agoRegular Contributor
Take a look here:
http://smartbear.com/forums/f74/t79381/documenting-jscript-with-jsdoc3/
I've documented our project using JSDoc3, works great. A bit of a pain to configure but nice once set up. I also use Grunt to monitor the project directory and run JSDoc to generate our documentation automatically whenever a change is checked into the project.
To setup I installed node.js first and then installed JSDoc plugin and Grunt using node's npm package manager. Note: you also need Java JDK installed as JSDoc requires Java and I would also recommend installing Git and Git Bash for Windows if you are using windows OS. I believe git was a pre requisitie for installing one of the two modules I mentioned as the npm package manager gets them from Github.
Oh, and remember to configure your choice of documentation tool to load script files with .sj and not .js.
Good luck!
http://smartbear.com/forums/f74/t79381/documenting-jscript-with-jsdoc3/
I've documented our project using JSDoc3, works great. A bit of a pain to configure but nice once set up. I also use Grunt to monitor the project directory and run JSDoc to generate our documentation automatically whenever a change is checked into the project.
To setup I installed node.js first and then installed JSDoc plugin and Grunt using node's npm package manager. Note: you also need Java JDK installed as JSDoc requires Java and I would also recommend installing Git and Git Bash for Windows if you are using windows OS. I believe git was a pre requisitie for installing one of the two modules I mentioned as the npm package manager gets them from Github.
Oh, and remember to configure your choice of documentation tool to load script files with .sj and not .js.
Good luck!
Related Content
- 12 years ago
Recent Discussions
- 2 days ago
- 2 days ago
- 6 days ago