Atom中没有官方api-docs插件，可用方案仅有dash插件对接Dash文档库或apidoc CLI手动生成HTML文档；查Java/Node.js API需安装dash插件及对应docset；自写Atom扩展API须用apidoc标准注释并正确执行生成命令。
Atom里没有叫 api-docs 的官方插件
直接搜“api-docs”装插件，大概率会装错——Atom 插件市场（apm）里并不存在一个叫 api-docs 的、能自动生成或本地托管 API 文档的插件。你看到的同名插件，通常是旧版废弃项目、功能残缺的 fork，或者只是个空壳。真正能用的方案只有两个：一个是 dash 插件对接本地 Dash 文档库；另一个是用 apidoc CLI 工具手动生成 HTML 文档后，在 Atom 里用浏览器预览。
想查 Java/Node.js 等语言 API？用 dash + Docset
这是 Atom 中最接近“本地快速查询”的真实路径：
-
apm install dash安装插件后，必须同步安装对应语言的 Dash 文档集（docset），比如java、nodejs、lodash，否则 Ctrl+H 按下就是空白 - Dash 应用本身要提前下载安装（macOS 上推荐用官网 dmg，Windows 用户需用 Dash for Windows 替代方案），Atom 的
dash插件只是个“遥控器” - 配置项
grammars必须写对，例如"JavaScript": ["nodejs", "lodash"]，否则光标停在_.map上不会弹出 lodash 文档 - 如果文档没反应，先检查 Dash 是否正在运行，再确认 docset 是否已勾选启用（Dash App → Preferences → Downloads）
想查自己写的 Atom 扩展 API？别指望插件自动解析
Atom 自身不带 AST 解析能力，任何插件都无法从 class 或 export default 里自动提取方法签名。可行做法只有：
- 用
apidocCLI，在函数上方写标准注释块：/** @api {get} /config 获取配置 */，且必须紧贴函数声明，不能隔空行 - 注意
apidoc不识别 ES6 class 方法，class MyPackage { activate() { ... } }会被忽略，得拆成独立函数，或加@apiName MyPackage#activate - 生成命令要指定输入目录：
npx apidoc -i lib/ -o docs/api/，其中lib/是编译后的 JS 目录（不是src/的 CoffeeScript 原始文件） - 生成完打开
docs/api/index.html，用 Atom 内置的markdown-preview-plus打不开——它只认 Markdown，得用系统浏览器或open-in-browser插件
容易被忽略的细节：注释格式和执行时机
写错一行注释，整个 API 条目就消失；晚跑一次命令，文档就和代码脱节。最常踩的坑是：
-
@param {string} name写成@param name {string}——apidoc直接跳过该参数，不报错也不提示 - 在
package.json里漏掉"docs"脚本，导致 CI 或队友无法复现文档生成过程 - 把
.apidoc.json放错位置（必须在项目根目录，不能放在docs/下），导致标题仍是默认的 “API Documentation” - 更新了函数参数但忘了改注释，生成的文档还是旧的——没人会主动 re-run
npm run docs
