Ruby 学习 —— 注释

Ruby 的代码注释，包括单行、多行、文档注释。
单行用#开头，本行的内容都会当作注释。字符串和正则表达式内的#号不会当做注释。

1. #这里是注释

复制代码

[多行用=begin开头， =end 结尾。例：

1. =begin
   
2. 这里是注释
   
3. =end

复制代码

文档注释用#后跟=号，一级标题用=，二级用两个=号，以此类推。
例：

1. # = ODM类
   
2. # 此类是 ODM的行为
   
3. # == Push
   
4. # Push 的方法
   
5. # === Pushpull
   
6. # = SUBAR 类
   
7. # 此类是 SUBAR类
   
8. class ODM
   
9.   def push
   
10.   end
    
11. end
    
12. class SUBAR
    
13.   def subarnew
    
14.   end
    
15. end

复制代码

这样写注释的好处是，使用 rdoc 命令，可以自动生成注释文档。