原文链接：How to document your JavaScript package
为什么要使用JSDoc
JSDoc 是一种很好的编写参考文档的方式，它与代码本身耦合，并且可以以多种格式供用户使用，比如 HTML、Markdown、JSON，或者在他们的IDE或文本编辑器中。
最佳实践
- 写一个简洁的摘要：JSDoc注释的第一段应该是对符号的简洁面熟，帮助用户快速理解其功能
- 提供良好的类型信息：类型信息有助于用户快速筛选功能列表，找到他们需要的功能
- 使用标签：像
@param、@returns和@typeParam这样的标签提供了有关函数或类的特定部分的更多信息 - 添加示例：示例有助于用户快速了解如何使用您的库
- 记录一切：记录您在包中公开的每个符号，包括如果您公开多个模块则包括整个模块
- 内部链接：使用
@link、@linkcode和@linkplain链接到文档的其他部分，以帮助用户浏览您的文档。 - 测试文档：如果使用
deno或者JSR, 在发布之前使用deno test --doc来对您的文档示例进行类型检查，并使用deno doc --link来检查您的JSDoc注释中的问题