YARD不能用<code>代码</ code>替换`code`是否正常？

Question

我刚刚开始使用YARD来记录我的Rails应用程序.我没有指定任何特定的标记处理程序,但我希望将`code`转换为code,似乎不会发生.这是正常的行为吗？我是否需要添加一些额外的选项才能使其正常工作？谢谢.

Answer 1

我认为语法与markdown(markdown vs rdoc)略有不同.使用'+'作品.+代码+在<code>块中呈现.

Answer 2

从GitHub,我习惯使用反引号进行内联代码注释.经过一些研究后我发现了以下非常好的解决方案.

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

现在你可以在GitHub上使用Syntax,例如

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

要么

`this is inline code`

太好了!:)

Answer 3

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

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

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