Ruby的文檔系統(tǒng)RDoc 3.10發(fā)布
RDoc 3.10 發(fā)布了,RDoc是針對Ruby源代碼的文檔系統(tǒng)。跟JavaDoc一樣,RDoc可以讀取原文件,分析源代碼中的語法信息和注釋文本,生成HTML格式的文檔。和JavaDoc不同的是,即便源代碼沒有任何注釋,RDoc也能生成相當(dāng)漂亮的文檔內(nèi)容。在編寫源程序的同時(shí)編寫RDoc可以說易如反掌。Ruby的內(nèi)建庫和標(biāo)準(zhǔn)庫文檔都是用RDoc生成的。應(yīng)該可以使用ri命令來訪問這些文檔,不過這也取決于你安裝Ruby的方式。
該版本增強(qiáng)了部分功能和修復(fù)了一些Bug,包括:
主要增強(qiáng):
◆ 改善了RDoc HTML輸出。
◆ 支持更多的文檔格式:TomDoc 1.0.0 - RC1和Rd格式。
◆ 現(xiàn)在可以保存和加載選項(xiàng)文件。
小幅改進(jìn):
◆ HTML標(biāo)題現(xiàn)在擁有和標(biāo)題匹配的id,如“= Hello!”呈現(xiàn)為“ <h1 id="label-Hello%21">Hello!</h1>”。
◆ 類或方法的標(biāo)簽可以通過添加一個(gè)“@”來鏈接到此類或方法的相關(guān)內(nèi)容。
◆ 針對HTML輸出,RDoc中SomeClass.method_name和SomeClass#method_name用于遠(yuǎn)程方法和屬性,::method_name and#method_name用于本地方法。
◆ 改進(jìn)了Ruby代碼的語法高亮。
◆ 新增了rdoc-label鏈接機(jī)制,允許雙向鏈接。
◆ HTTPS URL中的圖片路徑現(xiàn)在能被轉(zhuǎn)換成+<img>+ tags形式。
◆ 新增了RDoc::Comment,可對評(píng)論進(jìn)行處理。
另外,該版本還修復(fù)了一些Bug,詳細(xì)信息參閱:RDoc發(fā)行說明
Rdoc文檔:http://rdoc.rubyforge.org/
下載地址:https://github.com/rdoc/rdoc
【編輯推薦】