如何在不覆盖所有其他文件的情况下在单个文件上运行rdoc?

时间:2018-06-14 20:09:48

标签: ruby-on-rails ruby documentation rdoc code-documentation

我正在开发一个非常大的rails项目,我想在代码库中标准化rdoc的使用。我想我可以在整个项目中运行一次(至少为类和方法本身生成文档)然后开发人员可以在添加文档时添加单个文件。

问题在于,如果我运行rdoc /path/to/some_file.rb,它会从生成的index.html中删除所有其他文件,并且只包含该文件。在整个项目上运行rdoc需要3-4分钟,每次添加新注释时都不需要解析整个项目。 rdoc --help的输出不提供解决方案。

有没有办法配置rdoc,以便它始终保持文档,直到我再次专门对这些文件运行rdoc?

感谢您的任何见解!

1 个答案:

答案 0 :(得分:0)

我认为rdoc不会从index.html中删除任何内容,只会覆盖它而实际上没有能力对其进行修改。关于性能,我不确定100%,但很可能rdoc不会缓存解析结果。 Yard可以使用-c, --use-cache选项,并且可以大大加快工作速度。