如何在 Ruby 中向 RDoc 添加现有注释？[关闭]

Question

我想将现有评论格式化为“RDoc 评论”，以便可以使用以下方式查看它们 ri.

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

Answer 1

有几件事让我深受打击：

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

Answer 2

RDoc 使用 SimpleMarkup，因此创建列表等相当简单。使用 *、- 或数字。它还将在相同列号处缩进的行视为同一段落的一部分，直到出现表示新段落的空行。您是否有一些您想要 RDoc 的评论示例，以便我们可以向您展示如何操作，然后您可以将其推断为您的其余评论？