命名 (Naming)

  • 用 蛇命名法 (snake_case) 来命名 methods 和 variables。
    [link]

  • 用 驼峰命名法(CamelCase) 命名 class 和 module。 (缩写词如 HTTP, RFC, XML 全部大写)
    [link]

  • 用尖叫蛇命名法 (SCREAMING_SNAKE_CASE) 来命名常量。[link]

  • 断定方法的名字 (predicate methods) (意思是那些返回布尔值的方法) 应该以问号结尾。
    (比如 Array# empty?)。[link]

  • 有一定 “潜在危险” 的方法
    (意思就是那些. 会修改 self 的方法, 或者原地修改参数的方法, 或者带有 exit! 的方法, 等等) 应该以感叹号结尾. 这种危险方法应该仅当同名的不危险方法存在之后, 才存在. ([More on this][ruby-naming-bang].)
    [link]

  • 把不用的变量名命名为 _.
    [link]

    1.   payment, _ = Payment.complete_paypal_payment!(params[:token],
    2.                                                 native_currency,
    3.                                                 created_at)