Ruby的代码风格如何规范

Ruby 代码风格规范要点

一 基础格式与布局

• 使用UTF-8编码；换行统一为LF（Unix 风格）。
• 缩进使用2 个空格，不使用 Tab。
• 单行长度建议不超过80个字符，便于并排查看与代码审查。
• 在逗号、分号、运算符两侧保留空格；唯一的例外是指数运算符 ** 紧贴操作数**（如：M * c**2）。
• 在左括号 (, 左方括号 [ 之后以及右括号 ), 右方括号 ] 之前不加空格。
• case 与 when 对齐；def 与 def 之间保留1 个空行以分隔方法；避免在行尾保留空白字符。

二 命名与可读性约定

• 变量/方法：snake_case（如：user_name, calculate_total）。
• 类/模块：CamelCase（如：UserProfile, PaymentGateway）。
• 常量：SCREAMING_SNAKE_CASE（如：MAX_RETRIES）。
• 谓词方法以**?**结尾（如：empty?, valid?），避免 is_/does_/can_ 前缀。
• 具有破坏性/风险的方法以**!**结尾（如：save!, update!）。
• 二元运算符方法参数命名为**other**（如：def +(other)）。
• 迭代器变量使用有意义的名称，优先使用**each** 等迭代方式而非 for。

三 语法与流程控制

• 有参数时方法调用与定义使用括号；无参数时可省略括号。
• 避免 for 循环，优先 each/map/select 等迭代器；for 中的循环变量会泄漏到外层作用域。
• 多行 if/unless 不使用 then；条件简单时可用三元运算符替代。
• 不混用 unless 与 else。
• 多行方法链选择一种风格并保持统一：
  • 前导点：one.two.three.\n.four
  • 尾随点：one.two.three\n.four
• 控制行宽：超长行通过换行与对齐拆分，保持可读性。

四 集合、字符串与异常

• 创建字符串数组优先用**%w**（如：%w(red blue green)）。
• 遍历集合优先用**each**，避免 for。
• 哈希字面量两种风格择一并保持一致：{ name: 'John', age: 30 } 或 {name: 'John', age: 30}。
• 字符串插值内部不留空格："Hello, #{user.name}!"；简单字符串用单引号；拼接大量字符串优先**<<**。
• 异常处理：用明确的异常类型 rescue，避免捕获通用 Exception；按需 raise 自定义异常；不要用异常做流程控制。

五 注释、工具与团队协作

• 注释应解释意图与边界，避免冗余；复杂逻辑可配合注解：
  • FIXME：已知问题待修复
  • TODO：待办事项
  • OPTIMIZE：可优化点
• 文档注释遵循项目约定（如 RDoc），注释与 def 之间通常不留空行。
• 团队统一规范与自动化：
  • 使用 RuboCop 进行静态检查与自动格式化；
  • 采用 StandardRB 作为“零配置”规范执行工具；
  • 在仓库根目录维护 .rubocop.yml，并在 CI 中强制执行检查。