Join the #BuildWithBuildAgent Challenge! Get recognized, earn exclusive swag, and inspire the ServiceNow Community with what you can build using Build Agent.  Join the Challenge.

How to generate API documentation from JSDoc annotated implementations

Maik Skoddow
Tera Patron
Tera Patron

Is there any build-in tool / application at ServiceNow that could generate automatically an API documentation based on my JSDoc annotated Script Includes?

 
6 REPLIES 6

Hi @Daniel Oderbolz ,

thanks for tip. I tried this tool and was quite dissatisfied. UfortunateIy it doesn't follow the JSDoc rules and syntax. I would have to rewrite all existing comments to use this tool and would then have blocked my way through a JSDoc parser.

Hi @Maik Skoddow 
Yes, I agree, the  tool needs rewriting. As I mentioned in a comment

I think it would be better if the original code base (and syntax!). I am thinking of a tool that generates and manages Knowledge Articles in ServiceNow with as little overhead as possible.

The challenge here is that JSDoc has a quite different approach.


If this post was helpful, I would appreciate if you marked it as such - thanks!

Best
Daniel