Forum Discussion

Philip_Baird's avatar
Philip_Baird
Community Expert
13 years ago

Documenting JScript with JSDoc3

I would like to document my JScript code using JSDoc3 but cannot get it to work  as Test Complete creates files with an extension of .sj which JSDoc3 doesn not seem to allow. I can do this succ...
dbattaglia's avatar
dbattaglia
Contributor
10 years ago

TanyaYatskovska, will you please add a vote to the database for script documentation for me?

Having this feature built in would be a very big help to many of us.

 

All, thanks for sharing your workarounds.

chrisb's avatar
chrisb
Regular Contributor
10 years ago

I'd suggest adding a 'how to'  guide in the Test Complete documentation for a couple of popular documentation tools such as YUI docs or JSDoc. Adding a documentation feature would be re-inventing the wheel.

  • dbattaglia's avatar
    dbattaglia
    Contributor
    10 years ago

    chrisb good call, a support article is probably a better idea as long as the jsDoc et al options remain available/supported.

    Perhaps you can submit a draft to help things along?.. :smileyhappy:

     

    I haven't tried any of these options yet, but it's on my list.

     

    Thanks for sharing.

    • TanyaYatskovska's avatar
      TanyaYatskovska
      Icon for Alumni rankAlumni
      10 years ago

      Hi Guys,

      I’ve reported this suggestion to our documentation team. Thanks.