Ruby的文檔系統 RDoc

openkk 13年前發布 | 11K 次閱讀 Ruby

RDoc是針對Ruby源代碼的文檔系統。跟JavaDoc一樣,RDoc可以讀取原文件,分析源代碼中的語法信息和注釋文本,生成HTML格式的文檔。和JavaDoc不同的是,即便源代碼沒有任何注釋,RDoc也能生成相當漂亮的文檔內容。在編寫源程序的同時編寫RDoc可以說易如反掌。Ruby的內建庫和標準庫文檔都是用RDoc生成的。應該可以使用ri命令來訪問這些文檔,不過這也取決于你安裝Ruby的方式。(內容說明來自:http://www.iteye.com/news/22991)

gem 'rdoc'
require 'rdoc/rdoc'

options = RDoc::Options.new

see RDoc::Options

rdoc = RDoc::RDoc.new rdoc.document options

see RDoc::RDoc</pre>


Rdoc文檔: http://rdoc.rubyforge.org/
下載地址: https://github.com/rdoc/rdoc

 本文由用戶 openkk 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!