问题标签 [rdoc]

我正在使用 Doxygen 为 C++ 项目创建内部文档。我让 Doxygen 包含方法等的来源，但这使得页面难以扫描。我希望它表现得像 rdoc 并将源隐藏在默认折叠的块中。

我认为这HTML_DYNAMIC_SECTIONS可能会让我这样做，但可惜的是，变更日志说该选项只影响图表和图表。

也许我可以通过编辑来做到这一点LAYOUT_FILE？

无论如何，聪明的人，我怎样才能强制 Doxygen 生成可折叠的代码段？

我有一个用 Ruby 编写的程序，它使用多级继承。所有父类都实现了子类对象将使用的方法，但是当我为我的程序生成 rdoc 时，子类的 rdoc 页面仅显示该特定类的方法，而没有来自父类的方法.

有谁知道如何在 rdoc 中显示继承的类方法？我查看了 rdoc 文档和一些网站，但无法找到关于这是否可能的答案。

是否有任何 wiki 语法，如 rdoc、markdown、...在 ruby​​ 世界中推荐？我有时会编写开源代码，但我不知道应该在代码文档和自述文件中使用哪种语法。什么对我有帮助，你为什么使用它。

似乎很多库/插件都使用这种语法：

为什么这:nodoc:部分是必要的？

我知道可以在没有文档的情况下安装 gem，但不幸的是，我在使用 ruby​​ 的前三个月没有安装。在那段时间里，我设法安装了大量的 gem，但自从我开始使用 ruby​​ 以来，我没有一次在我的计算机上使用过文档。我总是在互联网上寻找文档。

从我的计算机中安全删除文档的最佳方法是什么？另外，有没有办法将 ruby​​ 配置为默认不安装文档？

对于您的 Rails 程序员，让您的 RDoc 文件保持最新的最简单方法是什么？

我知道我可以rake doc:app手动运行，但我真的不想在签入过程中添加手动步骤，而且由于我们已经使用Cruisecontrolrb来处理部署和测试自动化，似乎应该有一个简单的方法在签入时重新生成这些文件。

有人已经自动化了rake doc:app吗？如果是这样，你有什么建议？

我喜欢使用 Textile 或 Markdown 为我的项目编写自述文件，但是当我生成 RDoc 时，自述文件被解释为 RDoc 并且看起来非常糟糕。有没有办法让 RDoc 通过 RedCloth 或 BlueCloth 而不是自己的格式化程序运行文件？是否可以将其配置为自动检测文件后缀的格式？（例如 README.textile 通过 RedCloth 运行，但 README.mdown 通过 BlueCloth 运行）

我想链接到 RDoc 中文件的文档。但我能做的唯一方法是使用以下标记：

我想以更好的方式做到这一点，如下所示：

是否有任何现有的标记规则可以做到这一点？

编辑：当然我试过没有像这样的任何标记，configuration.rb但它显示的文件名没有链接:(

rdoc 是否有任何参数告诉它再次包含所有未更改的文件？

第二次（第三次，第四次）调用 rdoc，只是解析已经改变的文件，index.html 只显示这个解析文件的内容。其他文件在子目录中仍然可用，但未显示。

可能是一件容易的事情 - 但我找不到解决方案。

感谢您的提示... :)

我正在 Rails 之上开发一个开源 Web 应用程序。我想让我的代码尽可能容易理解和修改。我正在用单元测试来测试我的开发，所以很多代码都是通过测试用例“记录”的（每个控制器操作期望作为输入，为输出设置了哪些实例变量，应该如何调用帮助程序，什么业务逻辑模型合并等）。最重要的是，在我的代码符合它们的地方，Rails 的约定应该使大量文档变得不必要。

那么，拥有一个有据可查的 Rails 应用程序和努力遵守 Don't Repeat Yourself 之间的平衡点在哪里？是否有任何好的博客或文章指导哪些（RDoc）文档在 Rails 应用程序中真正有用，哪些只是浪费？