如何使用 TSDoc？

就其本身而言，@microsoft/tsdoc 包不是您可以直接使用的文档解决方案。 它是其他工具（如 API Extractor）使用的引擎组件。NPM 依赖关系报告是查找实现 TSDoc 的工具的简便方法。

即使您尚未为您的项目启用文档工具，采用 TSDoc 约定将使您的代码注释与其他工具更加兼容。

👉 要检查代码中的错误， 请安装 ESLint 的 eslint-plugin-tsdoc 插件

👉 要查看兼容的文档工具将如何呈现您的注释， 请尝试将您的 /** */ 注释粘贴到 TSDoc Playground 中！

👉 实施需要解析文档注释的工具？ @microsoft/tsdoc 包提供专业质量的解析器。api-demo 文件夹包含显示如何调用解析器的示例代码。

👉 有改进的想法？ 我们正在使用 GitHub issues 来讨论 TSDoc 规范、库设计和项目路线图。