Forum Discussion
Philip_Baird
11 years agoCommunity Expert
Hi, as an alternative I have been using Yahoos YUIDoc tool for documenting my JScript.
The main reason for this is that JSDoc3 can be very picky about where comments are placed and I was loosing whole blocks and it was a nightmare to get right.
YUIDoc avoids this by ignoring code altogeter and only looking at documentation blocks which means comments can be anywhere.
The downside to it is that you have to include a lot more meta tags you wouldn't normally need with JSDoc3 but I created a number of templates which minimises this.
Like Javier, I copy and convert the files but have written a Script Unit which does all the work so it's not that much of a task
The main reason for this is that JSDoc3 can be very picky about where comments are placed and I was loosing whole blocks and it was a nightmare to get right.
YUIDoc avoids this by ignoring code altogeter and only looking at documentation blocks which means comments can be anywhere.
The downside to it is that you have to include a lot more meta tags you wouldn't normally need with JSDoc3 but I created a number of templates which minimises this.
Like Javier, I copy and convert the files but have written a Script Unit which does all the work so it's not that much of a task
Related Content
- 2 months agoStoplight
- 8 years agoMulgraveTester
- 11 years agosbkeenan