如何将现有评论添加到Ruby中的RDoc?

我想将现有评论格式化为'RDoc评论',以便使用 ri 查看它们。

开始使用RDoc的一些建议资源是什么?

0
额外 编辑
意见: 17
查看文档
额外 作者 Tobias,

2 答案

有几件事让我感到困扰:

  • :main: -- RDoc uses only the last one evaluated; best to make sure there's only one in your project and you don't also use the --main command-line argument.
  • same as previous, but for :title:
  • :section: doesn't work very well
0
额外

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

0
额外