作为一名程序员, 每天最常见的动作就是查看各种 API 文档, 你一定也有过同时打开 N 个窗口(htmlPDFCHM), 不停的在编辑器与文档之间切换不仅消耗时间, 而且效率也低各个地方去找文档, 查看一个函数命令的使用, 还有各种 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 在最初发布的时候, 只支持很少的几个文档浏览, 好像只有 JavaHTMLCSS 这些, 是后来通过用户不断贡献, 以及作者及时的反馈(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
每个工具都带有用来创造它的那种精神.
来源: http://www.jianshu.com/p/43a23bb12c7d