JSDoc is a markup language used to annotate JavaScript source code files. It's like adding comments to your code, but with a bunch of extra cruft that can be parsed to generate documentation webpages that no one ever reads.

How to use it in a sentence

• "I can't push my code to the repo until I add JSDoc comments to every function, otherwise the build will fail and the tech lead will send a passive-aggressive message on Slack."

• "Our startup is really crushing it, we have 80% test coverage and JSDoc on every method! Sure, our only paying customer is leaving and we're about to run out of runway, but at least our code is well-documented!"

If you actually want to learn more...

• JSDoc - This article provides an overview of JSDoc and how it can be used to generate API documentation for JavaScript code.

• JSDoc - This piece dives into some best practices and conventions for using JSDoc effectively to document your JavaScript codebase.

• Treating Documentation Like Code with - Here, the author makes the case for treating documentation as a first-class citizen in your development process, and shows how JSDoc can facilitate this.

Note: the Developer Dictionary is in Beta. Please direct feedback to skye@statsig.com.