作为一名程序员,每天最常见的动作就是查看各种API文档,你一定也有过同时打开N个窗口(HTML、PDF、CHM),不停的在编辑器与文档之间切换。不仅消耗时间,而且效率也低。各个地方去找文档,查看一个函数命令的使用,还有各种google。下面介绍一个工具,帮你从这种繁琐的搜索中解脱。就是今天的主角 Dash
is an API Documentation Browser and Code Snippet Manager
功能介绍
官方用一句话就概括了它的用途:Dash是一个API文档浏览器和代码片段管理器。Dash存储代码片段,并立即搜索200多个API,100多个备忘单和更多的脱机文档集 。您甚至可以生成自己的文档集或请求包含的文档集。功能单一,但是很强大,需要的文档都有。
支持的文档集
Dash带有200多个离线文档集。您可以选择要下载的文档集,Dash将负责其他文档,确保它们保持最新状态。您还可以生成自己的文档集,请求docset或从第三方来源下载docset 。
下面列出了Dash附带的各种文档集。在最流行的那些突出。所有文档集已经生成并且保持在最新的状态。
第三方文档来源
惊人的集成插件
扩展功能
强悍的API文档浏览、搜索功能
想必这个功能是大家最常用的了吧,每天要反复查看、搜索那么多的API细节,没有一个好工具,单靠自己的双手如何应付得来?窗口不停的切来切去,很烦啊!Dash采用集成单一窗口的方式,很好的解决了这个问题。看下面的截图:
上图便是Dash的API浏览器主界面:左侧边栏是各种编程语言以及框架(取决于你下载安装了多少文档集合)的导航大纲,点击某个节点,右边的内容区域就是文档的详细信息啦,非常直观。也可以在左上方的搜索框内通过输入关键字,查找相关的API文档,非常类似全文检索的实现方式,Dash的响应速度非常快!关键是可以同时查询不同的语言、框架内容,实在是太方便了。看到这里你也许要问了,这跟我们平常切换到特定的文档窗口(比如一个PDF或者一个CHM文件),再ctrl + f查找有什么区别,不是多此一举吗?其实你错了,Dash可以通过快捷键来显示、隐藏文档窗口,它提供了配置界面以便用户自行设置(我比较习惯alt+space,因为其他软件很少用到这个组合键):
Dash自带了丰富的API文档,涉及各种主流的编程语言和框架,全列出来很吓人的:ActionScript, Android, C++, Cappuccino, Cocos2D, Cocos3D, Corona, CSS, Django, Groovy, HTML, Java, JavaFX, JavaScript, jQuery, Kobold2D, Lua, MySQL, Node.js, Man Pages, Perl, PHP, Python, Ruby, Ruby on Rails, Scala, Sparrow, SQLite, Unity 3D, WordPress, XSLT, XUL
而且它的文档库采用了docset格式,高级用户基于网站提供的教程,很容易就能自行添加其他的扩充文档,其实Dash在最初发布的时候,只支持很少的几个文档浏览,好像只有Java、HTML、CSS这些,是后来通过用户不断贡献,以及作者及时的反馈(Rails API就是我通过Email与作者联系,请求添加的,作者非常nice),逐步壮大,才具备了如此广泛的语言、框架支持。要添加API文档,打开软件配置界面,切换到Docset选项卡即可看到所有内置的文档列表,按需要自行下载即可(如果是自己制作的docset,双击即可导入Dash):
window & linux不要哭泣
我公司的电脑就是linux,我也找到了代替方案,至于windows也可以用,不过我就没有使用的经验了。
和Dash功能一样的软件zeal.
软件和Dash类似
支持的文档也是很多
这些文档就是来自于dash.
安装方法
window
下载: https://dl.bintray.com/zealdocs/windows/zeal-0.5.0-windows-x64.msi
https://dl.bintray.com/zealdocs/windows/zeal-0.5.0-windows-x86.msi
然后, 下一步,下一步,确认
linux:
# arch linux
sudo pacman -Syu zeal
# debian
sudo apt-get install zeal
# Fedora
sudo dnf install zeal
# Gentoo
emerge app-doc/zeal
# ubuntu
sudo apt-get install zeal
# openBSD
pkg_add zeal
每个工具都带有用来创造它的那种精神.