惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

博客园 - Franky
U
Unit 42
MyScale Blog
MyScale Blog
B
Blog
阮一峰的网络日志
阮一峰的网络日志
量子位
IT之家
IT之家
The GitHub Blog
The GitHub Blog
F
Fortinet All Blogs
Recent Announcements
Recent Announcements
V
Visual Studio Blog
G
Google Developers Blog
Last Week in AI
Last Week in AI
雷峰网
雷峰网
博客园 - 聂微东
博客园 - 叶小钗
OSCHINA 社区最新新闻
OSCHINA 社区最新新闻
让小产品的独立变现更简单 - ezindie.com
让小产品的独立变现更简单 - ezindie.com
J
Java Code Geeks
博客园 - 司徒正美
Y
Y Combinator Blog
T
The Blog of Author Tim Ferriss
月光博客
月光博客
aimingoo的专栏
aimingoo的专栏

少数派

派早报:Google 发布 Fitbit Air 等 - 少数派 「新人报到」確認需求,再開始 - 少数派 从 SOLO 独立开发者社区,我看到了越来越多开发者开始做自己的产品 - 少数派 我怎么管理那些"不常做,但总会忘"的生活事项 - 少数派 人形机器人量产元年,数据才是具身智能的“生死线” - 少数派 BuhoLaunchpad 高度还原 Mac 启动台:开发历程与思考 - 少数派 五年陪伴依然不舍,DIY 换壳后让罗技 MX Master 3 继续服役 - 少数派 新玩意 240|少数派的编辑们最近买了啥? - 少数派 一日一技|为什么你应该关闭 iOS 的键盘声音 - 少数派 我做了个插件和 Skills,一键提取任何网站的设计规范 Design.md - 少数派 住在三四线城市的你,该开始录播客了 - 少数派 甘南秘境,大白高国 - 少数派 AI的审美:谁让把我变成川内倫子 - 少数派 返工怎能不烦恼,打工人片单总有一部是你的「嘴替」 - 少数派 为了让「上厕所」更健康,我做了一个小工具 - 少数派 AI + Skill,能够让生成的文章去除 AI 味吗? - 少数派 新玩意|韶音OpenDots ONE 耳夹式耳机 - 少数派 《美满》| 在每一个春天的晚上相爱(362) - 少数派 新玩意|优篮子 PS01 MagSnap 磁吸支架 - 少数派 自我整合手记 | 我开始早睡了:用稳定规则,为自由托底 - 少数派 用龙虾(OpenClaw)两个多月,我最深的12个体会 - 少数派 听歌时间到,12 张你可能错过的 2025 华语乐坛好专辑 - 少数派 承诺能追吗 - 少数派 macOS 26启动台没了? 我做了个不一样的App启动器 - Keboard - 少数派 《四海为家的人》| INTJ对话INTJ(361) - 少数派 你发过的那些黑历史,是时候一次清干净了 - 少数派 新玩意:安安静静玩,越玩越专注:计客密码机 - 少数派 iPad 用户首次体验 Android 平板:vivo Pad6 Pro - 少数派 数据逻辑强 - 少数派 极北行+ | 一路向北,探访日本至北之地 | 001 - 少数派
程序员的 API 文档查询利器:Dash - 少数派
2018-07-24 · via 少数派

对于初入软件开发领域的新人及广大的计算机系在校生来说,API 文档算是众多难啃的硬骨头当中的一块。多数文档存在着交互不友好、索引不便的问题。本着人民有需求就要解决的精神,引入本期主角——Dash

Dash 对自身的定位是一款面向开发人员的文档查询工具。而事实上,无论是从易用性还是实用性上,Dash 都是极其强大的。简略概括如下:

  • 离线文档查阅:快速方便的 API 索引,包含 JavaScript、iOS、React、Haskell 等语言及库的文档及官方入门。
  • 第三方工具集成:与各个工具及编辑器 、IDE无缝集成,还有 jetBrain 家族、Xcode、Alfred 等等,你用的都在里面。
  • 自定义数据来源:已经包含 Google、Stack Overflow,你还可以自定义来自诸如 Medium、Quora 等任何你需要的网站。
  • 注释功能:方便快速的注释、标记功能。

可以说,Dash 绝对对得起它给自己的定位。用过之后,很可能就离不开它了。

离线文档查阅

Dash 首先是一款文档查询工具,这也是它最核心的地方。它基本上覆盖了所有主流及部分非主流语言、框架和库的文档,多数文档都来源于这些语言的官方,因此也包含了很多官方的入门介绍。

我们重点说说 API 查询。在 Dash 里查询 API 非常简单,你愿意的话可以在所有的已下载文档当中检索,或者通过双击选中某一个特定的文档之后,再输入关键字进行检索,这种情况下检索范围将会锁定在该文档内。Dash 的检索效率非常高,基本上都是秒出结果的。

检索结果

以 JavaScript 的文档为例,它被合理地分成了「类」「方法」「事件」「函数」「关键字」以及非常实用的、来自 MDN 的入门介绍。相较于在线的版本,Dash 这样的离线文档库的优势除了能应对更多的场景外,更在于所有的内容你都能一览无余,而且方便检索,无需忍受时快时慢的国外服务器。

离线检索

这是 canvas 的教程,这一部分来自 MDN(Mozilla Developer Network,Web 标准主要的制定与推动组织之一)。

canvas

第三方工具集成

出于作为一款开发及效率工具的定位,Dash 针对许多的工具与 IDE 都做了无缝集成。基本上你有用到的、你会用到的工具都在官方支持之列了。插件的安装方法在其 GitHub 对应的各个 Repository 上都有详细的安装指导,点击这上面对应的工具图标就可以找到了。

集成多种工具

以 Alfred 为例,甚至无需额外的步骤,点击图标之后会自动跳转到 Alfred,点击导入就安装好了。集成 Dash 之后索引甚至不用打开应用本身,不要太方便。

导入很方便

感受一下随手查阅的畅快感。

随手查阅

自定义数据来源

如果你觉得 Dash 的官方库不能满足你全部的需求,想要个性化地定制作为文档来源!

没问题,Google Stack Overflow 已经集成在内。你也可以使用任何你喜欢的社区作为自定义搜索库,添加的方式也很简单。以 Medium 为例,直接在上面搜索某个内容之后,复制网址。

添加 Medium

可以看到搜索的关键字就是网址的 q 之后的那一段,在 Dash 的首选项里的 Web Search 栏点击左下角的+,name 字段输入搜索来源的名称;Search URL 字段粘贴网址,然后将关键字替换成 {query} 之后就可以了。

添加自定义搜索库

添加注释

Dash 还附带了一个注释工具,你可以对文档的任意一个小节添加你的注释,这对学习应该会有不小的帮助,也符合各大学霸爱做笔记的风格。

注释工具

此外你也可以先 Mark 学习了一半的章节或者平时常用的 API,将它添加到书签,以备之后查阅。

Dash 本身可以免费使用,但免费版本在查找一个新文档的时候(不是每次查询)会有 10 秒的延迟时间。付费版本的价格为 $29.99。除了 Mac 端,Dash 还有 iOS 版本。iOS 版则完全免费,同样支持离线文档,此外还支持 URL Schemes 等特性,你可以在 App Store 下载或在 GitHub 下载源文件。

总的来说,Dash 这款工具在文档的广度与质量上已能满足大多数人群的使用场景,也提供了包括自定义数据来源、添加注释等个性化功能,对于学习工作上的帮助还是很明显的。学会搜索是技术成长路上不可或缺的一步,所以你会了吗?