返回 导航

其他

hangge.com

Dash - macOS下最好用的API文档工具(附:安装使用说明)

作者:hangge | 2021-02-07 08:10

1,基本介绍

(1)Dash 是一个 API 文档浏览器( API Documentation Browser),以及代码片段管理工具(Code Snippet Manager)。Dash 自带了丰富的 API 文档,涉及各种主流的编程语言和框架。使用它可以使得我们在编码时不需要在编辑器与文档之间不断切换,十分方便。
Dash 自带的 API 文档包括:iOS,macOS,watchOS,tvOS,Swift,Man Pages,.NET Framework,ActionScript,Akka,Android,AngularJS,Angular.dart,Ansible,Apache,Appcelerator Titanium,AppleScript,Arduino,Backbone,Bash,Boost,Bootstrap ,Bourbon,Bourbon Neat,C,C ++,CakePHP,Cappuccino,Chai,Chef,Clojure,CMake,Cocos2D,Cocos2D-X,CodeIgniter,CoffeeScript,ColdFusion,Common Lisp,Compass,Cordova,Corona,CSS,D3.js,Dart ,Django,Dojo Toolkit,Drupal,ElasticSearch,Elixir,Emacs Lisp,Ember.js,Emmet.io,Erlang,Express.js,Expression Engine,ExtJS,Flask,Font Awesome,Foundation,GLib,Go,Grails,Groovy,Grunt ,Haml,Haskell,HTML,Jade,Jasmine,Java SE,Java EE,JavaFX,JavaScript,Joomla,jQuery,jQuery Mobile,jQuery UI,Knockout.js,Kobold2D,Laravel,LaTeX,Less,Lo-Dash,Lua,Marionette .js,Meteor,MomentJS,MongoDB,Mongoose,Mono,MooTools,MySQL,Nginx,Node.js,NumPy,OCaml,OpenCV,OpenGL,Perl,PhoneGap,PHP,PHPUnit,Play框架,Polymer.dart,PostgreSQL,Processing.org,原型,Puppet,Python,Qt,R,Redis ,RequireJS,Ruby,Ruby on Rails,Rust,Sass,SaltStack,Scala,SciPy,Sencha Touch,Sinon,Smarty,Sparrow,Spring框架,SproutCore,SQLAlchemy,SQLite,Statamic,Stylus,SVG,Symfony,Tcl,Tornado,Twig ,Twisted,TYPO3,Underscore.js,Unity 3D,Vagrant,Vim,VMware vSphere,WordPress,Xamarin,Xojo,XSLT,XUL,Yii,YUI,Zend Framework,Zepto.js。Spring Framework,SproutCore,SQLAlchemy,SQLite,Statamic,Stylus,SVG,Symfony,Tcl,Tornado,Twig,Twisted,TYPO3,Underscore.js,Unity 3D,Vagrant,Vim,VMware vSphere,WordPress,Xamarin,Xojo,XSLT,XUL ,Yii,YUI,Zend Framework,Zepto.js。Spring Framework,SproutCore,SQLAlchemy,SQLite,Statamic,Stylus,SVG,Symfony,Tcl,Tornado,Twig,Twisted,TYPO3,Underscore.js,Unity 3D,Vagrant,Vim,VMware vSphere,WordPress,Xamarin,Xojo,XSLT,XUL ,Yii,YUI,Zend Framework,Zepto.js

(2)而利用 Dash 的代码片段管理功能,我们可以把日常使用频繁的代码保存起来,然后为其设置一个独一无二的缩写,这样就解决了原本需要一遍又一遍的敲击键盘重复录入的繁琐工作。 

2,下载安装

我们可以访问其官网(点击访问)进行下载并安装。

3,使用说明

(1)Dash 安装完毕后默认是没有任何 API 文档的,我们可以在 Downloads 页面中选择需要的 API 文档进行下载。

(2)为方便唤醒 Dash 窗口,我们还可以设置一下唤醒的快捷键,比如我这里设置为 option + D

(3)唤醒后我们就可以输入关键字,Dash 便能自动搜索所有的 API 文档:

  • 我们也可以输入“语言:关键字”,比如 vue:emit,这样就只会在指定的 API 文档中进行搜索:

(4)选择搜索结果后按下回车,便能显示详细的 API 信息。

4,代码片段管理功能

(1)首先在设置页面中开启 snippets 代码片段功能:

(2)接着我们创建一个代码片段,首先唤醒 Dash,然后点击输入框下方列表的 Snippets 开始创建:

(3)比如我这里创建一个 Ajax 请求的代码片段(缩写设置为 ajax)
(1)这里我们使用双下划线标明占位符,在执行扩展的时候就可以通过 tab 键来在各个占位符之间切换,根据需要输入实际的值,最后回车即可把片段粘贴到光标所在之处。
(2)除了占位符,它还支持下面这些变量符号:
  • @clipboard 自动插入当前剪贴板中的内容
  • @cursor 代码片段粘贴完毕之后,自动将光标定位到此处
  • @date 自动插入当前日期
  • @time 自动插入当前时间

(4)我们在任意编辑器中输入代码片段缩写,比如 ajax,则会自动弹出对应代码片段窗口。

(5)输入占位符内容后按下回车,则代码片段自动会插入到之前光标的位置。

附:Dash 与 Alfred 结合使用

(1)如果我们还安装了 Alfred,这二者是可以结合使用的。首先打开 Dash 的设置窗口,点击 Integration 页面下的 Alfred 按钮进行插件安装:
    Alfred Mac 系统上的一个专注于效率提升的著名应用,通过这个工具简单配置很多流程化的操作,就可以用很简单的命令实现自动化操作。关于 Alfred 详细的介绍可以参考我之前写的文章:

(2)打开 Alfred Workflows 页面,可以发现 Dash 脚本已经安装成功了。

(3)我们只需唤醒 Alfred 后在输入框中输入“dash 关键字”即可自动搜索所有的 API 文档:

(4)我们也可以输入“dash 语言:关键字”,比如 dash vue:emit,这样就只会在指定的 API 文档中进行搜索:
评论

全部评论(0)

回到顶部