我该如何处理与RDoc的自述文件，以显示Ruby脚本帮助/用法信息

Question

我想继续我的使用documenation的自述文件（杜），而不是评论我的脚本的顶部。我如何获得的RDoc ::使用拉使用信息进行自述的脚本注释呢？

Answer 1

RDoc的设计解析一个源文件，看看评论和它们的位置，变量的构建交叉引用，并完成时，这一切都捆绑到一个像样的输出。因为RDoc的设计工作对源文件可能不是你想要做什么是最好的选择。

相反，你可能想看看堆场，这是基于标记的。 我可以得到我的README.textile进入我的RDoc与正确的格式？对你有一些有用的信息了。

在这两种情况下，如果你不能得到应用解析自述型DOC像你想，你也许可以通过将您的所有文档文件中的欺骗它，用类和方法存根，因此沿解析器可以抓取参数，全局变量，和其他“诸如此类的东西”他们需要创建可用的文档。

否则，你可能要使用自动帮助放弃，并在输入了这一切。

我的建议是这样做的RDoc的方式，并记录你的代码中。这根本不难做到，并且输出可以是非常令人满意的。这是相当惊人的工作的RDoc如何好做的。

Answer 2

我当然没有足够的经验来告诉你答案，但请允许我一个忠告。

大多数开发商不可能永远更新的文件即使是3线执行上面的代码。

做一个忙，不要使这一过程更加困难。

保持通用文档分开是一个不错的主意，虽然，但它有没有在你的RDoc生成的输出做无妨。