程序员的 API 文档查询利器:Dash

QuillerVincent 发布于1年前
0 条问题

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

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

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

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

离线文档查阅

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

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

程序员的 API 文档查询利器:Dash

检索结果

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

程序员的 API 文档查询利器:Dash

离线检索

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

程序员的 API 文档查询利器:Dash

canvas

第三方工具集成

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

程序员的 API 文档查询利器:Dash

集成多种工具

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

程序员的 API 文档查询利器:Dash

导入很方便

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

程序员的 API 文档查询利器:Dash

随手查阅

自定义数据来源

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

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

程序员的 API 文档查询利器:Dash

添加 Medium

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

程序员的 API 文档查询利器:Dash

添加自定义搜索库

添加注释

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

程序员的 API 文档查询利器:Dash

注释工具

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

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

除了 Mac 端,Dash 还有 iOS 版本。iOS 版完全免费,同样支持离线文档,此外还支持 URL Schemes 等特性,你可以在 App Store 下载或在  GitHub 下载源文件。

查看原文: 程序员的 API 文档查询利器:Dash

  • yellowwolf
  • orangebutterfly
  • greencat
  • beautifulbird
  • redgoose
需要 登录 后回复方可回复, 如果你还没有账号你可以 注册 一个帐号。