使用rdoc生成chm

rdoc是Ruby自動生成文檔的工具。

rdoc生成的幫助文件是HTML格式的，rdoc提供“-f chm”命令參數生成chm文檔。做成chm模式便於搜索。

rdoc尋找的註釋文檔格式比較簡單，主要搜索method 、class、模块上緊接的註釋行，rdoc Parser會搜索rb文件中每一处符合条件的注释，并且认为它们是用于生成文档的注释。

鍵入如下命令，將會生成webrick的幫助文檔：

$ rdoc -f chm chm_webrick webrick  

生成的chm文件被放置在chm_webrick目錄下。

评论

2 楼 devworks 2007-04-30  

若支持pdf就更好了，不知xml是基于哪个方言生成的

1 楼 cfc 2007-04-30  

這個好！
這樣查閱起來就方便多了！
謝謝分享:)
趕緊做了個ActionMailer的:P