Dash:编码API文档工具简单介绍

前言

Programmer 是一直学习的一个职业,而学习最快也最深入的方式就是学习编码原始文档。
可是查找详细的原始文档是一个麻烦且低效的过程,今天在这里介绍一个神奇的工具——Dash。

Dash

Dash is an API Documentation Browser and Code Snippet Manager. Dash stores snippets of code and instantly searches offline documentation sets for 150+ APIs (for a full list, see below). You can even generate your own docsets or request docsets to be included.

引用 Dash 官网的介绍。
Dash 是一个 API 文档浏览器和功能代码文档管理器��。Dash API 文档商店拥有功能代码文档和超过150+的 API离线文档(查看完整列表,请参阅下文),你甚至可以生成自己的文档请求文档被某个项目采纳。

Dash 首页

Dash 首页的左侧目录可以看到已经下载的 API 文档列表,右侧是具体的功能按钮,包括下载文档、管理文档等。
Dash API 文档商店

Dash 文档商店可以看到所有 API 文档,最重要的是可以看到这边还可以前往 Maven或者 Github 进行开源项目的 API 文档查找和下载(截图不全,在左侧菜单栏的第二页),简直是 Programmer 的倚天剑屠龙刀!
Dash 显示 API 文档

Dash 的 API 文档的具体内容的展示页,也就是原版的最正确的 API 文档(不带有任何译者的个人理解和情感),读原文才能真正提升对代码的了解啊!

怎么玩转 Dash

“作者,你这样说了,我还是得进 Dash 查找 API 文档啊,只是把打开 Google 的操作改成了打开 Dash 啊,没差啊?!”有些读者可能发问道。的确,到这里为止,查找 API 文档还是很麻烦,可是我还没说完呢,开发者社区的力量是无限大的,Dash 也开发了接口供其他 App 快速访问,所以,接下来介绍的几个工具将让你“WOW”!

Intellij IDEA

Intellij IDEA 要下载 Dash 插件,进入 Preferences -> Plugins,在搜索输入框键入 Dash,点击搜索线上仓库,安装 Dash,重启 Intellij IDEA,开始神奇之旅吧,鼠标点击需要查询 API 文档的元素或方法,点击键盘快捷键 Cmd+Shift+D(Mac OS用户)或者 Ctrl+Shift+D(Windows、Linux 用户),WOW,直接跳转到了 Dash 中关于该查询项的 API 文档的详情页啦(因为是模糊搜索,可能出现了非该语言的结果,没事,左侧搜索框选择正确的文档)。


Intellij IDEA Plugin

VS Code、Atom

VS Code 和 Atom同样需要安装 Dash 插件:VS Code 选择左侧主要功能菜单的最后一项扩展工具,输入 Dash,安装 Dash 插件;Atom 选择首选项-Install,输入 Dash,安装 Dash 插件。尽情放肆吧,鼠标点击需要查询 API 文档的元素或方法,点击键盘快捷键 Ctrl+h(查找当前文件的 Code 语言的 API 文档)或者 Ctrl+alt+h(查找所有 API 文档),WOW,直接跳转到了 Dash 中关于该查询项的 API 文档的详情页。


VS Code Plugin

Atom Plugin

其他开发工具 IDE

当然了 Dash 既然开放了接口,那么伟大的社区自然会适配所有主流的 IDE,各位看官可以前往Dash 官网查找或者在自己顺手 IDE 的插件管理界面添加 Dash 插件,具体快捷键请仔细查看 Dash 插件的介绍页。

致谢

感谢 肥朝 的工具分享博客《码农日常工具推荐》的介绍,让我认识了 Dash,并且爱上了 Dash。

写在最后

Dash 非常优秀,但是 Dash 并不是一个免费的工具,有条件的各位希望能够付费支持,希望好工具不会迫于压力停摆,而是能够继续造福整个社区。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,951评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,606评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,601评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,478评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,565评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,587评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,590评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,337评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,785评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,096评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,273评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,935评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,578评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,199评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,440评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,163评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,133评论 2 352

推荐阅读更多精彩内容