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

提供为