Ruby 风格指南

这是 Airbnb 的 Ruby 风格指南。

它受到了 Github 指南 和 Bozhidar Batsov 指南 的启发。

目录

1. 空白

   1. 缩进
   2. 内联
   3. 换行
2. 行长

3. 注释

   1. 文件/类级别注释
   2. 函数注释
   3. 块注释和内联注释
   4. 标点符号、拼写和语法
   5. TODO 注释
   6. 注释掉的代码

4. 方法

   1. 方法定义
   2. 方法调用

5. 条件表达式

   1. 条件关键字
   2. 三元运算符
6. 语法
7. 命名
8. 类
9. 异常
10. 集合
11. 字符串
12. 正则表达式
13. 百分号字面量
14. Rails 特定部分
15. 保持一致性

保持一致性

如果你正在编辑代码，花几分钟时间看看你周围的代码，并确定它的风格。如果他们所有的算术运算符周围都使用空格，你也应该这样做。如果他们的注释周围有小的井号方框，那么你的注释也应该有小的井号方框。

制定风格指南的目的是为了拥有通用的编码词汇，这样人们就可以专注于你所说的内容，而不是你如何表达它。我们在这里提出全局风格规则，以便人们了解词汇，但是局部风格也很重要。如果你添加到文件的代码与周围的现有代码看起来大相径庭，那么读者在阅读时就会被打乱节奏。避免这种情况。

—— Google C++ 风格指南