（2）内嵌文档

我们前面提到，Ruby的#注释方式不支持注释内容的换行，也没有类似Java的/*....*/，注释方式，不过Ruby提供了另一种多行注释方式，你可以以=begin开头=end结尾，包含在这个两个关键字中的内容会被当作注释内容，并且不会被Ruby语法解析器解析:

=begin
 多行文本注释的例子，
 你可以在其中写任意内容，甚至是其他语言的代码片段，
 所有这其中的内容都会被Ruby语法解析器忽略。
=end

这里需要注意的一点是，以上提到的注释方式必须以=begin开头并以=end结尾，如果你在使用#注释的方式，那么就不生效了，比如下面：

#=begin 
  这里的内容不再是注释
#=end

Ruby 提供了一个rdoc工具，你可以通过它来查看一个模块、类或者方法的说明文档，在你自己编写一个类的时候你可以在类的开头加入注释内容，说明你这个类是干什么的，或者一个方法是完成什么工作的，那么通过Ruby的rdoc工具，其它的人就可以很容易的知道这个类、模块或者方法的细节，你可以在每行开头使用#来添加文档注释，也可以使用=begin和=end，具体的内容可以参考 lib/rdoc/README 中描述的内容。