jsdoc 支持

ESLint 支持

如果您希望为您的文档启用 JSDoc 生成，请同时启用 JSDoc 的 ESLint 插件（如果尚未启用）。

在顶级 .eslintrc.js 文件 中，目前有两个部分启用了 valid-jsdoc 和 require-jsdoc 规则。请检查您的组件是否被排除在这些部分之外。如果是，您应该删除排除项并修复运行时引发的任何实例

./mach eslint path/to/component/

启用 JSDoc 生成

这是一个快速示例，用于公共 AddonManager API

将其用于您自己的代码

  1. 检查 JSDoc 是否生成了您期望的输出（例如，您可能需要在“对象初始化程序”样式的类定义上使用 @class 注解）

  2. 创建一个.rst 文件，其中可能包含解释性文本以及 API 文档。最小值看起来像 这样。

  3. 确保您的组件位于 sphinx 配置文件中的 js_source_path 中： https://hg.mozilla.org/mozilla-central/file/72ee4800d415/tools/docs/conf.py#l46

  4. 在本地运行mach doc 以生成输出并确认它看起来正确。