post Documenting ServiceNow Code with JSDoc Standards in Developer Advocate Blog

Documenting ServiceNow Code with JSDoc Standards

Earl Duque — Tue, 04 Mar 2025 19:13:56 GMT

In ServiceNow development, proper documentation is crucial for maintaining code quality and ensuring that functions are easily understandable by other developers. For me, I prefer using JSDoc standards for documenting my code, so let me give you a brief rundown in case you’ve never heard of it.

Re: Documenting ServiceNow Code with JSDoc Standards

Vasantharajan N — Thu, 06 Mar 2025 09:16:38 GMT

@Earl Duque - Thank you for such wonderful blog about automated function documentation which is one of the best practice which many of the developers are not following. This automated approach really helps developers build meaning full coding.

Question:- To generate the function documentation for the code, Hope we need to post the code which will be processed by the ChatGPT or other AI platform. Do we need to consider or have any mechanism to sanitize the code before we post to ChatGPT or other AI Platform?

It would be great If you suggest any guardrail that can be established to avoid any compliance issue for such automated approach.

Re: Documenting ServiceNow Code with JSDoc Standards

VaranAwesomenow — Sat, 08 Mar 2025 06:14:55 GMT

@Vasantharajan N one way to address compliance concern is to deploy LLM locally on midserver and consume LLM services from there, that way you are still using the power of GENAI but the data never leaves client environment. You can refer to below community article on how to setup GENAI solution onprem using midserver.

ServiceNow GENAI solution using Ollama API - ServiceNow Community

Re: Documenting ServiceNow Code with JSDoc Standards

Dave65 — Thu, 17 Jul 2025 15:06:04 GMT

Hi Earl
Great article but, I'm on government contracts and can't use any of the LLM's.
How would I generate the final document in that case? I can manually add the comments without an LLM.

Thanks,

Dave