我想将我的使用文档保存在自述文件（duh）中，而不是在脚本顶部的注释中。如何获取RDoc :: usage来从自述文件中提取使用信息而不是脚本注释？
答案 0 :(得分：1)
RDoc旨在解析源文件，查看注释及其位置，构建变量的交叉引用，并在完成后将其全部绑定到一个合适的输出中。因为RDoc旨在对源文件起作用，所以它可能不是您想要做的最佳选择。
相反，您可能希望查看基于标记的Yard。 Can I get my README.textile into my RDoc with proper formatting?也为您提供了一些有用的信息。
在任何一种情况下，如果您无法让应用程序像您想要的那样解析README类型的文档，您可以通过将所有文档放在文件中以及类和方法存根来欺骗它，以便解析器可以获取参数，全局变量以及创建可用文档所需的其他“诸如此类的东西”。
否则，您可能不得不放弃使用自动帮助并输入所有内容。
我的建议是以RDoc方式进行，并在代码中记录。它根本不难做到，输出效果非常令人满意。 RDoc能做得多好，这真是太棒了。
答案 1 :(得分：0)
我当然没有足够的经验告诉你答案，但请允许我提出一条建议。
大多数开发人员不太可能更新文档，即使它在实现之上有3行代码。
帮忙，不要让这个过程更难。
保持通用文档分离是一个不错的主意，但无论如何它都与RDoc生成的输出无关。