【问题标题】:Ruby - when I should use parenthesis or not when calling a function/methodRuby - 当我应该在调用函数/方法时使用括号时
【发布时间】:2023-03-12 00:55:02
【问题描述】:

在调用函数/方法时,是否有明确的标准或指南使用或不使用括号?

例如下面的代码:

class List < Jets::Stack
  sqs_queue(:dead_letter)
end

我应该还是不应该使用括号?其他例子:

class ExampleJob < ApplicationJob
  def sqs_event ref(:dead_letter)
  end
end

对比

class ExampleJob < ApplicationJob
  def sqs_event ref :dead_letter
  end
end

有我可以遵循的官方指南吗?

【问题讨论】:

  • 我不认为第二个或第三个是有效的 Ruby,除非有一些我不知道的特性。
  • 括号应该在必要时使用,当你不确定它们是否可以省略时,以及当你知道它们不需要时,你想提高可读性。使用不必要的括号的唯一缺点是,具有特定个性特征的 Ruby 同胞在检查您的代码时可能会挑眉。
  • 我建议始终使用括号,因为这样很明显你的意图是什么,而且语言不会出错。

标签: ruby standards conventions


【解决方案1】:

Ruby 代码最佳实践没有官方标准。然而,在 Ruby 社区中已经形成了一组首选样式。遵循这些首选样式是个好主意,因为它使您的代码更容易被其他 Ruby 程序员阅读。

Nick Roz 为您提供了样式指南的链接。我还建议您考虑安装和使用rubocop。它会给你反馈什么时候和什么时候不给参数加上括号,许多其他格式问题,比如正确的缩进,以及在特定情况下可以选择几种不同的语法选项中的哪一种。

要回答您关于是否对方法参数使用括号的具体问题,一般来说,答案是肯定的。正如指南所说,例外是“在 Ruby 中具有‘关键字’状态的方法”。一个例子是puts(实际上是Kernel.puts 方法)。大多数人在这里不使用括号,但指南指出它们是可选的。

另一个例子,正如尼克所说的(虽然“带有关键字参数的方法”并不完全正确;在这种情况下,参数是表示方法而不是关键字的符号),是attr_accessor,实际上是Module.attr_accessor .

因此,作为一般规则,如果它看起来像一个“命令”(如果您愿意的话,是一个“关键字”),但实际上是一个方法,请省略括号。否则,请使用它们。如果您不确定其中的区别,请养成使用 rubocop 的习惯。

【讨论】:

    【解决方案2】:

    在 Ruby 中,它通常是可选的。

    Ruby 倾向于极简主义,因此经常被避免。

    有时它们是必需的,例如在 rspec 中期望在哪里

    expect a.to be true
    

    必须是

    expect(a).to be true
    

    在调用具有参数的方法时不使用括号或空括号会导致ArgumentError,除非您设置了参数的默认值,即

    def a(x=1)
    

    另一个考虑是当你想在某事的结果上调用一个方法时,你需要让那个方法清楚地出现在最终结果上,即

    "br" + "own".upcase 
    
    brOWN
    

    然而

    ("br" + "own").upcase
    
    BROWN
    

    最后,正如我所说的清晰度,有时拥有它们可能会更好,即使不是严格需要。这通常在复合表达式中,而不是依赖于运算符优先级等。或者,如果您想要一个专门不按标准运算符优先级执行的表达式,并且您想要自己的分组和操作顺序,例如:

    irb(main):007:0> 5 + 6 * 2
    => 17
    irb(main):008:0> (5 + 6) * 2
    => 22
    

    正如尼克指出的那样,一个复杂的问题是super,其中super 或super() 传递参数,但super(a,b) 调用super 与... a,b 作为参数

    【讨论】:

      【解决方案3】:

      根据Matz:

      如果为方法提供参数,它们通常被包围 括号,

      object.method(arg1, arg2)
      

      但如果这样做不会引起歧义,则可以省略它们。

      object.method arg1, arg2
      

      【讨论】:

        【解决方案4】:

        Yes there is

        我想您正在寻找社区指南,因为没有来自 Ruby 核心团队的样式指南。

        好吧,每当你调用一个方法时,你应该使用括号,否则会变得不清楚

        # bad
        x = Math.sin y
        # good
        x = Math.sin(y)
        
        # bad
        array.delete e
        # good
        array.delete(e)
        
        # bad
        temperance = Person.new 'Temperance', 30
        # good
        temperance = Person.new('Temperance', 30)
        

        但建议在没有参数时跳过它们。

        注意super 和super() 它们是不同的。 super 不带括号会隐式传递所有参数。 super() 带空括号省略所有参数

        我想到的唯一例外是某种自定义 DSL,例如 DSL 本身必须有一些规则或偏好。

        validates :name, presence: true
        

        对于带有关键字参数的方法也是如此:

        attr_reader :name, :age
        

        【讨论】:

        • 虽然您的规则总体上是一个不错的规则(如有疑问,请使用括号),但我会提醒您,一个常见的例外是 puts 和 @987654330 通常省略括号@方法调用。
        • super和super(0)有什么区别
        • @FedericoCapaldo super 不带括号会隐式传递所有参数。带括号的super() 不隐式传递任何参数,所以super() 表示调用不带参数的超级方法
        猜你喜欢
        • 2011-02-11
        • 1970-01-01
        • 1970-01-01
        • 2015-09-05
        • 1970-01-01
        • 1970-01-01
        • 2020-10-12
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多