在 Ruby 中显式返回是一种好的风格吗？

Question

来自 Python 背景，在风格方面总是有一种“正确的方式”（一种“Pythonic”方式），我想知道 Ruby 是否也存在同样的情况。我一直在使用自己的风格指南，但我正在考虑发布我的源代码，并且我希望它遵守任何可能存在的不成文规则。

在方法中显式输入return 是“Ruby 方式”吗？我已经看到它有没有完成，但是有正确的方法吗？是否有合适的时间去做？例如：

def some_func(arg1, arg2, etc)
  # Do some stuff...
  return value # <-- Is the 'return' needed here?
end

Answer 1

旧的（和“已回答的”）问题，但我会扔掉两美分作为答案。

TL;DR - 您不必这样做，但在某些情况下它可以使您的代码更加清晰。

虽然不使用显式返回可能是“Ruby 方式”，但对于使用不熟悉代码或不熟悉 Ruby 的此功能的程序员来说，它会造成混淆。

这是一个有点人为的例子，但是想象一下有一个像这样的小函数，它给传递的数字加一，并将它分配给一个实例变量。

def plus_one_to_y(x)
    @y = x + 1
end

这是否意味着是一个返回值的函数？很难说开发人员的意思是什么，因为它既分配了实例变量，又返回了分配的值。

假设很久以后，另一个程序员（可能不太熟悉 Ruby 如何根据执行的最后一行代码返回结果）出现并想要放入一些打印语句进行日志记录，并且函数变成了这个......

def plus_one_to_y(x)
    @y = x + 1
    puts "In plus_one_to_y"
end

现在函数被破坏了如果有任何东西需要返回值。如果没有任何东西期望返回值，那很好。很明显，如果在代码链更下游的某个地方，调用它的东西期望返回值，它将会失败，因为它没有得到预期的结果。

现在真正的问题是：真的有任何东西期望返回值吗？这是否破坏了某些东西？它会在未来破坏一些东西吗？谁知道！只有对所有调用进行完整的代码审查才能让您知道。

因此，至少对我而言，最佳实践方法是非常明确地表明您正在返回一些重要的东西，或者当它不重要时什么也不返回。

所以在我们的小演示函数的情况下，假设我们希望它返回一个值，它会这样写...

def plus_one_to_y(x)
    @y = x + 1
    puts "In plus_one_to_y"
    return @y
end

而且任何程序员都非常清楚它确实返回了一个值，而且他们更难以在没有意识到的情况下破坏它。

或者，也可以这样写，省略 return 语句...

def plus_one_to_y(x)
    @y = x + 1
    puts "In plus_one_to_y"
    @y
end

但是为什么要省去返回这个词呢？为什么不把它放在那里，让它 100% 清楚发生了什么？它实际上不会影响您的代码的执行能力。

Answer 2

没有。良好的 Ruby 风格通常只会对提前返回使用显式返回。 Ruby 擅长代码极简主义/隐式魔法。

也就是说，如果显式返回会使事情更清晰或更易于阅读，那么它不会造成任何损害。

Answer 3

我个人使用return 关键字来区分我所说的函数式方法，即主要为返回值执行的方法和过程方法主要是因为它们的副作用而执行。因此，对于返回值很重要的方法，需要额外添加一个 return 关键字来引起对返回值的注意。

我在调用方法时使用相同的区别：函数式方法有括号，过程式方法没有。

最后但并非最不重要的一点是，我还将这种区别用于块：功能块得到花括号，程序块（即“做”某事的块）得到do/end。

但是，我尽量不要对此持宗教态度：对于块，花括号和do/end 具有不同的优先级，而不是添加显式括号来消除表达式的歧义，我只是切换到另一种样式。方法调用也是如此：如果在参数列表周围添加括号使代码更具可读性，我会这样做，即使所讨论的方法本质上是程序性的。

Answer 4

其实重要的是要区分：

1. 函数 - 为其返回值执行的方法
2. 过程 - 为产生副作用而执行的方法

Ruby 没有本地方式来区分这些 - 这使您容易编写过程 side_effect() 和另一个开发人员决定滥用您的过程的隐式返回值（基本上将其视为不纯函数）。

要解决此问题，请参考 Scala 和 Haskell 的书，并让您的过程明确返回 nil（在其他语言中也称为 Unit 或 ()）。

如果您遵循这一点，那么是否使用明确的return 语法只是个人风格的问题。

进一步区分函数和过程：

1. 复制 Jörg W Mittag 的好主意，即用花括号编写功能块，用do/end 编写程序块
2. 调用过程时，使用()，而调用函数时，不要

请注意，Jörg W Mittag 实际上提倡相反 - 避免 ()s 用于过程 - 但这是不可取的，因为您希望副作用方法调用与变量明显区分开来，特别是当 arity 为 0 时。请参阅 @ 987654321@了解详情。

Answer 5

The style guide 声明，您不应该在最后一条语句中使用return。你仍然可以使用它if it's not the last one。这是社区严格遵守的约定之一，如果您打算与任何使用 Ruby 的人合作，您也应该遵守。

---

话虽如此，使用显式returns 的主要论据是它会让来自其他语言的人感到困惑。

• 首先，这并不完全是 Ruby 独有的。例如 Perl 也有隐式返回。
• 其次，这适用于大多数人来自 Algol 语言。其中大部分都比 Ruby“低级”，因此您必须编写更多代码才能完成任务。

java 中方法长度（不包括 getter/setter）的常见启发式方法是 一个屏幕。在这种情况下，您可能看不到方法定义和/或已经忘记了您从哪里返回。

另一方面，在 Ruby 中，最好坚持使用方法 less than 10 lines long。鉴于此，人们会想知道为什么他必须多写约 10% 的陈述，而这些陈述是明确暗示的。

---

由于 Ruby 没有 void 方法，而且一切都更加简洁，如果您使用显式 returns，您只会增加开销而没有任何好处。

Answer 6

我同意 Ben Hughes 的观点，但不同意 Tim Holt 的观点，因为这个问题提到了 Python 的明确方式，并询问 Ruby 是否有类似的标准。

It does.

这是该语言的一个众所周知的特性，任何希望在 ruby​​ 中调试问题的人都应该合理地了解它。

Answer 7

这是您最喜欢哪种风格的问题。如果要从方法中间的某个位置返回，则必须使用关键字 return。

Answer 8

就像本说的。 “ruby 方法的返回值是函数体中最后一条语句的返回值”这一事实导致 return 关键字在大多数 ruby​​ 方法中很少使用。

def some_func_which_returns_a_list( x, y, z)
  return nil if failed_some_early_check


  # function code 

  @list     # returns the list
end