动态文档,使用方法在另一个院子里的描述回报?(Dynamic documentation, usin

2019-10-16 15:40发布

我记录一个项目,essientially我有类似下面的内容:

def foo
  return bar(__method__)
end

def bar (method)
 return method.to_s + 'somestring'
end

我设立的方式类似,我已经实现富他们,他们正在返回酒吧的回报,其中一个方法众多。 一个例子如下:

# The descriptions for foo0...
# @return [String] the method name concatenated with somestring
def foo0
  return bar(__method__)
end
# The descriptions for foo1...
# @return [String] the method name concatenated with somestring
def foo1
  return bar(__method__)
end

# The descriptions for bar...
# @return [String] the method name concatenated with somestring
def bar (method)
 return method.to_s + 'somestring'
end

但说我改变什么bar正在返回一个整数,然后我的文档不正确。 我熟悉YARD记录的DSL,但你怎么只指定#bar@return.type的方法的返回返回类型bar描述的另一种方法时。 什么我指的是如下的例子:

# The descriptions for foo0...
# @return [#bar@return.type] the method name concatenated with somestring
def foo0
  return bar(__method__)
end
# The descriptions for foo1...
# @return [#bar@return.type] the method name concatenated with somestring
def foo1
  return bar(__method__)
end

# The descriptions for bar...
# @return [String] the method name concatenated with somestring
def bar (method)
 return method.to_s + 'somestring'
end

最终,我试图做到的是,而不必像定义返回类型是依赖于什么样的另一种方法被定义为绝对来记录我的代码。

更新:我发现,你可以调用# @return (see #bar)并把它列出回报或foo方法一样bar的方法,但我不能确定如何简单的得到它正在返回的类型和/或过载回报的说明bar有用于自定义说明foo

Answer 1:

当你发现,你应该使用@return (see #bar)的复制@return标签从#bar逐字到其他文档字符串。 注意:将复制的说明文字了。 有没有办法只有一个插值方法的类型。 你似乎并不需要它在你的具体的例子,虽然。



文章来源: Dynamic documentation, using the return of method in the description of another YARD?