如何在Ruby中添加现有的注释?

Translate

我想将现有评论的格式设置为“ RDoc评论”,以便可以使用ri.

推荐使用RDoc的一些推荐资源?

This question and all comments follow the "Attribution Required."

所有的回答

Translate

一些困扰我的事情:

  • :main:-RDoc仅使用评估的最后一个;最好确保项目中只有一个,并且不要同时使用--main命令行参数。
  • 与之前相同,但针对:title:
  • :section:不太好用
来源
Translate

RDoc使用SimpleMarkup,因此使用*,-或数字创建列表等非常简单。它还将在同一列号处缩进的行视为同一段落的一部分,直到出现空行表示新段落为止。您是否有一些想要RDoc'ed的注释示例,以便我们向您展示如何进行处理,然后可以在其余注释中进行推断?

来源