在 Ruby 中，可以使用 RDoc 工具来进行文档化和注释。 RDoc 是 Ruby 的官方文档工具，可以从 Ruby 标准库中自动生成文档。
RDoc 使用一些特定的注释格式来生成文档。其中最常见的是使用 # 开头的单行注释和使用 =begin 和 =end 包裹的多行注释。单行注释可以用于对方法、类、模块等进行注释，多行注释可以用于对整个文件进行注释。
例如，对于一个方法，可以使用以下格式的单行注释：
# 这是一个加法方法，用于计算两个数的和
# @param [Integer] a 第一个加数
# @param [Integer] b 第二个加数
# @return [Integer] 两个数的和
def add(a, b)
a + b
end在注释中可以使用一些特定的标记来标识参数类型、返回值类型等信息。例如，@param 标记用于标识方法的参数类型，@return 标记用于标识方法的返回值类型。
在代码中添加注释后，可以使用 RDoc 工具自动生成文档。例如，执行以下命令可以生成一个 HTML 格式的文档：
rdoc your_file.rb生成的文档将包含文件中所有的注释内容，并且可以在浏览器中查看。
除了 RDoc 工具外，还有其他一些 Ruby 文档工具，例如 YARD 和 TomDoc。这些工具使用的注释格式可能略有不同，但是基本原理相同。