如何在Ruby中将现有注释添加到RDoc？

Question

我想将现有评论格式化为“RDoc评论”，以便可以使用ri查看这些评论。

开始使用RDoc有哪些推荐资源？

Answer 1

一些困扰我的事情：

• :main: - RDoc仅使用最后评估的一个;最好确保项目中只有一个，并且您也不使用--main命令行参数。
• 与之前相同，但适用于:title:
• :section:效果不佳

Answer 2

RDoc使用SimpleMarkup，因此使用*， - 或数字创建列表等非常简单。它还会将同一列号缩进的行视为同一段落的一部分，直到有一个表示新段落的空行。你有几个你想要RDoc的评论的例子，所以我们可以告诉你如何做它们然后你可以推断其余的评论吗？