【问题标题】:How do I add existing comments to RDoc in Ruby? [closed]如何在 Ruby 中向 RDoc 添加现有注释? [关闭]
【发布时间】:2010-09-05 05:32:55
【问题描述】:

我想将我现有的 cmets 格式化为“RDoc cmets”,以便可以使用 ri 查看它们。

对于开始使用 RDoc 有哪些推荐的资源?

【问题讨论】:

标签: ruby rdoc


【解决方案1】:

有几件事让我很伤心:

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

【讨论】:

    【解决方案2】:

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

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2016-01-26
      • 2013-01-27
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2012-05-29
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多