如何防止RDoc解析URL?

时间:2011-01-13 02:18:44

标签: ruby rdoc

假设我有以下课程。

class Foo

  # I want the following to appear as-is in my documentation, not as an anchor tag. 
  #
  # http://www.google.com/
  #
  def bar
    puts "bar"
  end
end

然后我通过rdoc运行它。

$ rdoc foo.rb

它产生了这个:

<div class="method-description">
  <p>
    I want the following to appear as-is in my documentation, not as an anchor tag.
  </p>
  <p>
    <a href="http://www.google.com">www.google.com</a>/
  </p>
</div>

我想让它生成这样的东西:

<div class="method-description">
  <p>
    I want the following to appear as-is in my documentation, not as an anchor tag.
  </p>
  <p>
    http://www.google.com/
  </p>
</div>

实现这一目标的最佳方法是什么?

1 个答案:

答案 0 :(得分:3)

第1步

确保您正在使用:

ruby 1.9.2
rdoc 2.5.8

第2步

逃避它,你应该没事。

class Foo

  # I want the following to appear as-is in my documentation, not as an anchor tag. 
  #
  # \http://www.google.com/
  #
  def bar
    puts "bar"
  end
end

输出:

<div class="method-description"> 
  <p>
    I want the following to appear as-is in my documentation, not as an anchor tag.
  </p>  
  <p>
    http://www.google.com/
  </p>
</div>