没有类/过程/对象的脚本的RDoc

时间:2012-06-18 20:47:21

标签: ruby rdoc

如果内部没有任何结构,是否可以使用RDoc或任何其他文档生成器来记录ruby脚本?

1 个答案:

答案 0 :(得分:4)

RDoc真的被设计用于具有结构的代码;对于你所谈论的那种事情,你可以看一下Rocco。 (该链接也是Rocco生成的文档的一个示例。)

  

Rocco是Docco的Ruby端口,这是一个快速而又脏兮兮的百行文字编程风格的文档生成器。

     

Rocco读取Ruby源文件并以HTML格式生成带注释的源文档。评论的格式为Markdown,并与语法高亮显示的代码一起显示,以便提供注释效果。此页面是针对its own source file运行Rocco的结果。