JavaDoc Tool for Testcomplete
Do we have any facility to Tools such as JavaDoc that can be used in Testcomplete?
Forum Discussion
- @Tanya, I think some documentation with regards to how to integrate popular documentaiton tools with Test Complete would be sufficient. Seems that a few of us have figured it out ourselves with no issues so why not put up some online documentation such as 'how to' guides for other users? Took me a couple of days to figure out how to set up JSDoc3 but I could do it again in 10 minutes now I have the knowledge. A how to guide would have been invaluable. Given the limited number of Javascript documentaiton tools I would say that a couple of guides for YUI Doc and JSDoc setup would satisfy most Test Complete users.
Hi Sushil,
As I understand, you mean creating documentation on scripts automatically based on specially formatted comments in the script. If so, currently, this cannot be done via TestComplete's features. However, in our DB, there is a suggestion to implement such a feature, and your request has increased its rating. Thank you.
BTW, refer to this SQAforums page - you can find there some tools that you can use.
- I'd love to see something like that on TestComplete.
Hi Joffre,
I've added your vote to the suggestion. Thanks!
- Hi,
PLZ, add my vote for such feature.
Tks - 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!
Hi,
Ted, I've added your vote.
Chris, thanks for sharing your approach.
- +1 for that.
Actually Tanya, I'm using yuidoc for my files. As it is open source, can you implement it inside TC? I have no idea about the consequences of this in terms of licenses, I'm just fishing here...
Hi Jose,
Your vote was counted, as well.
I cannot tell you right now if we will implement YUIDoc in TestComplete - I'll pass this info to our TestComplete management.- Tanya, +1 please ;)
