Ruby 注释

在 Ruby 中，注释是用来解释代码的非执行内容。注释使得代码更容易阅读和理解，因为它们允许程序员向代码中添加对程序逻辑的解释，而这些解释并不会被程序执行。

单行注释

单行注释以井号（#）开头，并且在其后的所有内容都被认为是注释。

# 这是一个单行注释
puts "这是一个漂亮的代码" # 这是另一个单行注释

多行注释

多行注释被称为块注释，出现在代码块的顶部或中间，并用于向读者传达代码块的目的或解释。

Ruby 没有内置的多行注释语法，但多行注释可以用 Ruby 的强大字符串语法来模拟，如下所示：

=begin
这是一个多行注释。
它可以被用在程序的任何地方。
=end

puts "这是一个漂亮的代码"

文档注释

文档注释是一种特殊的注释，它们是用来描述类、方法和常量的。 文档注释通常被其他工具（如 RDoc）用来自动生成文档。

文档注释以两个井号（##）开头并被紧贴在类名、方法名或常量名之前。它们使用一种基于 Markdown 的语法来格式化注释。

# == 类名
#
# 这是一个描述类的文档注释。
class MyClass
  # 方法名
  #
  # 这是一个描述方法的文档注释。
  #
  # 参数:
  #   x - 整数参数
  #   y - 整数参数
  #
  # 返回:
  #   两数之和
  def add(x, y)
    return x + y
  end
end

小结

注释非常有用，以帮助读者理解代码。Ruby 提供了单行注释、多行注释和文档注释等多种注释方式。在编写注释时，请使用明确、简洁和清晰的语言来描述代码的目的和行为。