方法 (Methods)

方法定义 (Method definitions)

  • 函数要接参数的时候就用括号, 不用参数时就不用写括号了。 下面是正确的例子.[link]

    1.    def some_method
    2.      #  body omitted
    3.    end
    5.    def some_method_with_parameters(arg1, arg2)
    6.      #  body omitted
    7.    end

  • 不要用默认参数，用一个选项 hash 来做这个事。[link]

    1.   #  错误
    2.   def obliterate(things, gently = true, except = [], at = Time.now)
    3.     ...
    4.   end
    6.   #  正确
    7.   def obliterate(things, options = {})
    8.     default_options = {
    9.       :gently => true, #  obliterate with soft-delete
    10.       :except => [], #  skip obliterating these things
    11.       :at => Time.now, #  don't obliterate them until later
    12.     }
    13.     options.reverse_merge!(default_options)
    15.     ...
    16.   end

  • 避免定义单行函数，虽然有些人喜欢这样写，但是这样容易引起一些奇怪的问题
    [link]

    1.   #  错误
    2.   def too_much; something; something_else; end
    4.   #  正确
    5.   def some_method
    6.     #  body
    7.   end

方法调用 (Method calls)

应该用 圆括号 的情况：

  • 如果方法会返回值。
    [link]

    1.   #  错误
    2.   @current_user = User.find_by_id 1964192
    4.   #  正确
    5.   @current_user = User.find_by_id(1964192)

  • 如果第一个参数需要圆括号。[link]

    1.   #  错误
    2.   put! (x + y) % len, value
    4.   #  正确
    5.   put!((x + y) % len, value)

  • 方法名和左括号之间永远不要放空格。[link]

    1.   #  错误
    2.   f (3 + 2) + 1
    4.   #  正确
    5.   f(3 + 2) + 1

  • 对于不用接收参数的方法， 忽略圆括号 。[link]

    1.   #  错误
    2.   nil?()
    4.   #  正确
    5.   nil?

  • 如果方法不返回值 (或者我们不关心返回值)，那么带不带括号都行。
    (如果参数会导致代码多于一行， 建议加个括号比较有可读性)
    [link]

    1.   #  okay
    2.   render(:partial => 'foo')
    4.   #  okay
    5.   render :partial => 'foo'

不论什么情况:

  • 如果一个方法的最后一个参数接收 hash， 那么不需要 { } 。
    [link]

    1.   #  错误
    2.   get '/v1/reservations', { :id => 54875 }
    4.   #  正确
    5.   get '/v1/reservations', :id => 54875