美文网首页杂物间
Dash:编码API文档工具简单介绍

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

作者: 活这么大就没饱过 | 来源:发表于2017-03-20 23:21 被阅读858次

    前言

    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 并不是一个免费的工具,有条件的各位希望能够付费支持,希望好工具不会迫于压力停摆,而是能够继续造福整个社区。

    相关文章

      网友评论

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

        本文链接:https://www.haomeiwen.com/subject/eezinttx.html