文章

Rdoc

Rdoc

🧭 Ruby 官方文档(docs.ruby-lang.org)阅读 Roadmap

https://docs.ruby-lang.org/en/4.0/

🎯 目标

学会把 Ruby 官方文档当作:

📚 “API 字典 + 源码地图”,而不是教程


🟢 阶段 1:建立“查文档能力”(1–3 天)

🎯 目标

看到一个方法 → 知道去哪查

📍 重点页面

  • Array
  • Hash
  • String
  • Enumerable

🧪 训练方式

每天做:

  1. 写 Ruby 代码
  2. 遇到不懂的方法(如 map, select, join)
  3. 打开 docs 查:
    • 方法定义
    • 示例
    • 返回值

✅ 你要达到的能力

  • 不再依赖搜索引擎
  • 能直接查 Ruby API

🟡 阶段 2:理解 Ruby 核心抽象(3–7 天)

🎯 目标

理解 Ruby 的“能力来源”

📍 必看模块

🔹 Enumerable(最重要)

  • map
  • select
  • reduce
  • each

👉 理解:大多数集合操作都来自它


🔹 Comparable

  • <, >, sort

🔹 Kernel

  • puts
  • p
  • require

🧪 训练方式

对每个方法问三个问题:

  • 它属于哪个 module?
  • 它依赖 block 吗?
  • 返回什么类型?

✅ 你要达到的能力

  • 知道“方法不是随机的,是模块提供的”

🔵 阶段 3:掌握文档结构(7–14 天)

🎯 目标

能快速读懂任意 API 页面

📍 每个方法页结构

你必须能识别:

  • Method signature
  • 参数(是否可选)
  • 返回值
  • 示例
  • 是否修改原对象(! 方法)

🧪 训练方式

选任意方法,比如:

  • Array#map
  • Hash#merge
  • String#split

练习:

用 30 秒总结这个方法在做什么


✅ 你要达到的能力

  • 快速理解陌生 API

🔴 阶段 4:进入“源码级理解”(可选进阶)

🎯 目标

理解 Ruby “内部怎么实现”

📍 内容

  • MRI C 源码(通过 Doxygen)
  • GC 机制
  • Array / Hash 内部结构

🧪 训练方式

  • 在文档点 “Show source”
  • 看 C 实现
  • 对比 Ruby API

✅ 你要达到的能力

  • 知道“Ruby 是如何实现这些方法的”

🧠 使用文档的核心方法(总结)

❌ 错误方式

  • 从头读
  • 当教程看
  • 记 API

✅ 正确方式

“遇到问题 → 查文档 → 用 → 再回来查”


🚀 一句话总结

Ruby 文档不是书,而是“工具箱说明书” 你不是读它,而是用它解决问题


本文由作者按照 CC BY 4.0 进行授权