我想使用 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 中是否有任何功能可以让我完成此任务?我查看了创建自定义模板,但这似乎与解析代码有关。然后我检查了创建一个自定义 Markdown 模板,但我没有看到这可以或应该如何完成。我开始觉得我找错了树,希望能给我一个 Google 关键字。
为什么我首先要尝试解析 HTML:
正如我在前面的问题中所描述的,我正在尝试定义一个接口(interface)而不必复制代码。在此示例中,我希望服务器“调用”危险的方法与不危险的方法不同。
最佳答案
Markdown 允许您包含内联 html。所以也许试试:
# Here is my method
# @arg woop [Woop] <div class="custom">dangerous</div> this ....
def shoop...
...
如果这可行,您就可以覆盖 doc/css/common.css
文件中的默认 css。
关于ruby - 制作自定义 YARD Markdown ,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/19309250/