Question

我希望使用YARDoc来记录以下方法。

# Here is my method
# @arg woop [Woop] *dangerous* this parameter is output to the screen
def shoop(woop)
  puts woop
end

这会生成HTML，dangerous以粗体显示。因为我必须解析此输出，所以我希望有一个自定义HTML标记。换句话说，我想这样做，以便当YARDoc解析以下代码注释时，dangerous一词被<div class="custom"></div>标记包围，而不是<b><\b>标签，使用Nokogiri更容易解析。并不是说目前无法用Nokogiri进行解析，它只是有点尴尬，容易受到YARD代码变化的影响。

# Here is my method
# @arg woop [Woop] **dangerous** this parameter is output to the screen
def shoop(woop)
  puts woop
end

YARD中是否有任何功能可以让我完成此任务？我看了创建自定义模板，但这似乎更多的是解析代码。然后，我检查了创建自定义降价模板，但我没有看到这是如何实现或应该完成的。我开始得到的印象是我正在咆哮错误的树，并且会感激Google关键词引起了我的兴趣。

为什么我首先尝试解析HTML：
正如我在之前的问题中所描述的那样，我正在尝试定义一个接口，而不必重复代码。在这个例子中，我希望服务器“调用”一种危险的方法，而不是一种不危险的方法。

Answer 1

Markdown允许您包含内联HTML。所以也许试试：

# Here is my method
# @arg woop [Woop] <div class="custom">dangerous</div> this ....
def shoop...
...

如果这样可行，则可以覆盖doc/css/common.css文件中的默认css。

自定义YARD降价

1 个答案: