เพิ่มประสิทธิภาพ Rails: หยุดคำถามที่รบกวน Workflow ของคุณ

Practicing Rails is out! Get it for 25% off until Friday, February 13th.

ขณะที่คุณเขียนโค้ด คำถาม湧 上来 在 你 的 头脑 中 constantly: 我 如何 调用 这个 方法? 它 接受 什么 选项? 如果 我 传递 一个 对象 而不是 数字 会 发生 什么?

这些 问题 摧毁 你 的 生产力 当 你 不 知道 答案 立刻 你 会 忘记 你 正在 做 什么 你 被 拉出 你的 flow 并且 花费 半小时 才能 回到 你 离开 的 地方

那么 你 如何 找到 你 需要 的 答案 而不 放慢 脚步?

Fast lookup

速度 是 当 你 查找 API 文档 时 的 关键 你 想要 获取 你 的 答案 并 尽快 离开 否则 太 容易 偏离 轨道 我 无法 计算 我 有 多少 次 需要 知道 一个 方法 的 参数 并 以某种 方式 最终 在 reddit 上 看 尴尬 的 短信 一 小时

对于 速度 文档 你 将 想要 Dash, 对于 Mac, 或 Zeal, 对于 其他 一切 有了 这些 工具 你 可以 按 键盘 上 的 两个 键 并 调出 你 需要 的 文档 而不必 思考 你 正在 做 什么

但 它们 需要 一 点 设置

一旦 你 下载 其中 一个 应用 做 这 两件事:

1. 下载 你 使用 的 libraries 的 docsets

   我 抓取 Ruby, Rails, CSS, HTML, 和 Javascript 的 文档 大约 就 这些 如果 有 复杂 的 gem 你 经常 使用 像 Nokogiri 抓取 那些 文档 太 但 别 过头 – 如果 你 有 太多 文档 你 会 变慢 当 你 试图 弄清楚 你 实际上 指 哪个 concat 方法

2. 设置 Global Search Shortcut 在 Mac 上 我 通常 使用 option-Space

   这是 什么 将 Dash 从 "just another doc site" 变成 一个 完全 必不可少 的 工具 一旦 你 设置 了 global search shortcut 你 可以 按 option-Space 开始 输入 看到 你 需要 的 文档 再按 option-Space 一次 并 拥有 你 的 答案 甚至 没有 意识到 你 刚刚 做 了 什么 你 可以 回答 你 的 API 问题 在 你 知道 你 有 它们 之前

细节, 问题, 和 评论

不幸的是 有时 API 文档 没有 所有 你 想 知道 的 细节 或 你 可能 需要 知道 一个 功能 在 内部 如何 工作

你 将 不得不 牺牲 速度 来 回答 这些 问题 但 有 一个 文档 网站 用 细节 和 社区 替换 那 速度

APIDock

APIDock 只 覆盖 Ruby, Rails, 和 RSpec 但 它 仍然 有帮助:

• APIDock 会 告诉 你 Rails 方法 何时 被 deprecated 以及 你 应该 使用 什么 代替 它 跟踪 Rails 中 的 版本 到 版本 变化 一直 回到 1.0 所以 如果 你 正在 使用 legacy Rails 代码 它 是 一个 不可思议 的 资源

• 很多 API 方法 有 评论 由 Rails 开发者 贡献 评论 真的 很好 有了 APIDock 你 会 听到 edge cases 和 常见 问题 之前 你 遇到 它们

你的 新 文档 工作流

那么 你 如何 把 所有 这个 放 在 一起?

1. 当 你 对 API 有 问题 使用 热键 快速 调出 Dash 或 Zeal
2. 如果 你 需要 更多 细节 去 网络 先 试 APIDock 特别是 如果 你 在 搜索 一个 API 在 一个 旧 的 Rails 应用 中

当 你 可以 即时 找到 文档 它 将 改变 你 的 Rails 生产力 你 不仅 会 保持 更 专注 你 将 甚至 学到 更多 关于 你 依赖 的 libraries 和 frameworks

你 不能 知道 所有 关于 每个 工具 你 使用 的 一切 你 将 总是 依赖 文档 在 某个 层面 所以 花 一点 时间 现在 以 节省 时间 当 你 查 东西 它 将 通过 你 的 整个 编程 职业生涯 大规模 回报