Learn how to write comprehensive documentation for your JavaScript package using JSDoc-style comments. Discover best practices, how to provide good type information, and how to add examples to your comments.
Table of contents
Why JSDoc?A brief intro to JSDocProvide good type informationTags, tags, tagsAdd examples to JSDocBut what should I document?Use markdown for a better documentation experienceLink internally to other parts of your documentationKeep JSDoc up-to-date with code changesAudit your JSDocWhat’s next?3 Comments
Sort: