Ruby 中常用的代码风格规范是什么？-JavaScript中文网-JavaScript教程资源分享门户

本题详细解读

1. 缩进

Ruby 社区普遍采用两个空格作为缩进标准，而不是制表符。这有助于保持代码的一致性，并避免在不同编辑器中显示不一致的问题。

def example_method
  if condition
    puts "Hello, World!"
  end
end

2. 命名

Ruby 的命名约定非常明确：

变量和方法名使用 snake_case，例如 user_name。
类名和模块名使用 CamelCase，例如 UserController。

class UserController
  def get_user_name
    user_name = "John Doe"
  end
end

3. 行长度

每行代码尽量不超过 80 个字符。如果一行代码过长，可以将其拆分为多行。

long_string = "This is a very long string that exceeds the 80 character limit, " \
              "so it is split into multiple lines."

4. 方法定义

在 Ruby 中，方法定义时括号是可选的，但为了代码的清晰性，建议在方法有参数时使用括号。

def greet(name)
  puts "Hello, #{name}!"
end

5. 字符串

优先使用单引号表示字符串，除非字符串中包含插值或转义字符。

name = 'John'
greeting = "Hello, #{name}!"

6. 条件语句

避免使用 unless 与 else 结合，优先使用 if，以提高代码的可读性。

// www.javascriptcn.com code example
# 不推荐
unless condition
  puts "Not met"
else
  puts "Met"
end

# 推荐
if condition
  puts "Met"
else
  puts "Not met"
end

7. 注释

注释应写在代码上方，使用 # 进行单行注释。多行注释可以使用 =begin 和 =end，但不推荐。

# This is a single-line comment

=begin
This is a multi-line comment,
but it's not commonly used.
=end

8. 空行

在方法定义之间、类定义之间以及逻辑块之间使用空行进行分隔，以提高代码的可读性。

// www.javascriptcn.com code example
class User
  def initialize(name)
    @name = name
  end

  def greet
    puts "Hello, #{@name}!"
  end
end

9. 数组和哈希

使用 %w 或 %i 创建数组时，避免在元素之间添加不必要的空格。

# 推荐
fruits = %w(apple banana orange)

# 不推荐
fruits = %w( apple banana orange )

10. 块

单行块使用 {...}，多行块使用 do...end。

# 单行块
[1, 2, 3].each { |n| puts n }

# 多行块
[1, 2, 3].each do |n|
  puts n
  puts n * 2
end

通过遵循这些代码风格规范，可以使 Ruby 代码更加一致、易读和易于维护。

Ruby 中常用的代码风格规范是什么？

推荐答案