23

我刚刚开始使用 YARD 来记录我的 Rails 应用程序。我没有指定任何特定的标记处理程序，但我预计 `code` 会被转换为code，这似乎不会发生。这是正常行为吗？我是否必须添加一些额外的选项才能完成这项工作？谢谢你。

4

3 回答 3

21

我想语法与markdown（markdown vs rdoc）有点不同。使用'+'作品。+code+ 呈现在一个<code>块中。

于 2012-07-27T06:33:47.623 回答
19

在 GitHub 上，我习惯于使用反引号进行内联代码注释。因此，经过一些研究，我发现了以下非常好的解决方案。

  • 将redcarpetgem 添加到您的 Gemfile
  • 运行bundle命令
  • 添加--markup=markdown到您的.yardopts文件中
  • 使用启动 YARD 服务器yard server --reload
  • 在浏览器中打开 localhost:8808

现在你可以像在 GitHub 上一样使用语法，例如

```ruby
def bla; puts 'bla'; end
```

或者

`this is inline code`

好的！:)

于 2012-07-27T09:44:32.043 回答
9

如果没有降价，YARD 将显示缩进行的代码块，例如

  # This is a useful POSIX regex:
  #   [[:lower:]]{2}[[:digit:]]{3}[[:lower:]]{2}[[:digit:]]{4}

两个缩进空间似乎就足够了。

于 2014-08-15T00:57:16.017 回答