Ruby 學(xué)習(xí) —— 注釋

Ruby 的代碼注釋，包括單行、多行、文檔注釋。
單行用#開頭，本行的內(nèi)容都會當(dāng)作注釋。字符串和正則表達式內(nèi)的#號不會當(dāng)做注釋。

1. #這里是注釋

復(fù)制代碼

[多行用=begin開頭， =end 結(jié)尾。例：

1. =begin
   
2. 這里是注釋
   
3. =end

復(fù)制代碼

文檔注釋用#后跟=號，一級標(biāo)題用=，二級用兩個=號，以此類推。
例：

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

復(fù)制代碼

這樣寫注釋的好處是，使用 rdoc 命令，可以自動生成注釋文檔。