如何在 Ruby 中向 RDoc 添加现有注释？ [关闭]
[英]How do I add existing comments to RDoc in Ruby? [closed]
问题描述
我想将我现有的评论格式化为“RDoc 评论”，以便可以使用ri查看它们。
有哪些适合开始使用 RDoc 的推荐资源？
2 个解决方案
解决方案1
16 2008-08-23 04:48:20
有几件事让我心痛：
-
:main:-- RDoc 只使用最后一个评估的； 最好确保您的项目中只有一个，并且不要同时使用--main命令行参数。 - 与之前相同，但对于
:title: -
:section:不太好用
解决方案2
10 2008-08-02 10:22:41
RDoc 使用 SimpleMarkup，因此使用 *、- 或数字创建列表等相当简单。 它还将在相同列号处缩进的行视为同一段落的一部分，直到出现表示新段落的空行。 您是否有一些您想要 RDoc 的评论示例，以便我们可以向您展示如何执行它们，然后您可以将其推断为您的其余评论？
如何使用rdoc处理自述文件以显示ruby脚本帮助/使用信息
[英]how do I process a readme file with rdoc to display ruby script help/usage info
我应该如何为 Ruby 关键字参数提供 YARD/RDoc 文档？
[英]How should I provide YARD/RDoc documentation for Ruby keyword arguments?
声明:本站的技术帖子网页，遵循CC BY-SA 4.0协议，如果您需要转载，请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.