制作自定义 YARD 降价

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。