rdoc - rdoc 中的行继续

Question

继承了一堆带有rdoc注释的Ruby代码，但是很多选项和属性都是多行的，比如:

# +param+:: Here is a parameter with a really long description
#  that won't fit in one line

最终结果是使用 rdoc、sdoc 或 yard 很难阅读文档。每个都以不同的方式显示第二行。我错过了什么吗？有没有什么方法可以保留换行，但使生成的文档正确无误？

Answer 1

在 YARD 中，可以通过简单地添加没有任何特殊注释的另一个注释行来继续该行，只需缩进至少两个字符。您可以在此处找到它的记录:https://www.rubydoc.info/gems/yard/file/docs/Tags.md

例如下面这段代码:

# class description
class Test
  # @param [String] one this parameter has an astonishingly
  #  long description
  def method(one)
    nil
  end
end

呈现为