我刚刚开始使用YARD来记录我的Rails应用程序。我没有指定任何特定的标记处理程序,但我本以为code
会转换为code
,但这似乎并没有发生。这是正常行为吗?我是否必须添加一些额外的选项才能使其正常工作?谢谢。
发布于 2012-07-27 14:33:48
我想语法与markdown (markdown vs rdoc)有点不同。使用'+'
是可行的。在<code>
块中呈现+code+。
发布于 2012-07-27 17:44:32
在GitHub中,我习惯于在代码内联注释中使用反引号。因此,经过一些研究,我找到了以下非常好的解决方案。
yard server --reload
redcarpet
gem添加到Gemfilebundle
命令--markup=markdown
添加到<代码>D9文件现在你可以在GitHub上使用语法,例如
```ruby
定义bla;放置'bla';结束
或
`this is inline code`
不错!:)
发布于 2014-08-15 08:57:16
如果没有标记,YARD将显示缩进行的代码块,例如
# This is a useful POSIX regex:
# [[:lower:]]{2}[[:digit:]]{3}[[:lower:]]{2}[[:digit:]]{4}
两个空格的缩进似乎足够了。
https://stackoverflow.com/questions/11665723
复制相似问题