在构建源代码视图时,是否有方法跳到yard中的下一个def关键字?

用例

假设我在写一个托尔程序。理想情况下,我会这样记录:

require 'thor'

class Foo < Thor
  ##
  # prints the current version of the gem
  #
  # @example 
  #   foo version
  # @return [String] current version
  desc 'version', 'show the current version of the gem'
  def version
    puts('0.0.0')
  end
end

但是,文档中的view source选项将只显示desc行

为了获得正确的源输出,您需要将文档放在方法定义的正上方。 随着文档复杂性的增加,这可能是一个问题,因为它使您的desc方法调用远离它所涉及的方法。

require 'thor'

class Foo < Thor
  desc 'version', 'show the current version of the gem'
  ##
  # prints the current version of the gem
  #
  # @example 
  #   foo version
  # @return [String] current version
  def version
    puts('0.0.0')
  end
end

环境详细信息

• 操作系统:Ubuntu 16.04
• Ruby版本:Ruby 2.4.4p296
• 码版本:码0.9.16

最后说明

我似乎找不到一种方法来配置yard来忽略以前的代码 def ,或跳过以 desc . 我最近发现的是 https://github.com/lsegal/yard-thor 似乎大部分都没有记录和维护。

是否有任何yard配置或插件允许我将所有thor代码放在一起,并生成正确的源代码视图输出?

在源输出中包含desc调用和方法定义的选项也可以工作。