如何包含非代碼嵌入式（rdoc）rubygem可分發文檔？

我在做一個rubygem。 RDoc非常適合記錄類的方法和字段，但是我希望有一個「概述頁面」，該頁面具有模塊的基本結構概要，說明類與其相關的內容等等。將代碼嵌入到代碼中看起來不太合適每次加載文件時，解釋器都必須解析它。如何包含非代碼嵌入式（rdoc）rubygem可分發文檔？

在rubygem中包含這種文檔是否正確？如果是這樣的話，如何將這種非代碼嵌入式文檔包含在rubygem中？

另外，是否安裝rubygem，建立一個「預編譯」緩存版本在運行時使用，使加載速度更快，所以大量的文檔不是問題？或不？

2016-03-03 peterk

對於解釋，RDoc的符號只是註釋，而不是解析（除了'＃'，'= begin'，'= end'），它們的效果是可以忽略的。 – sawa

有時很難查找文檔上的文檔生成:)

但是我的回答是，你可以控制的RDoc的行爲，並指定額外的文件，包括建設，並在gemspec對象安裝寶石時：

spec.extra_rdoc_files = [ '自述'， 'DOC /用戶guide.txt']

spec.rdoc_options < <「--titl E」 < < '耙 - 紅寶石製作' < < ' - 主' < < '自述' < < '--line號碼'

2016-03-05 02:10:34 peterk

回答