Ruby YARD:构建源代码视图时跳至下一个方法定义

时间:2018-11-15 11:17:39

标签: ruby documentation thor yard

构建源代码视图时,是否可以跳过码中的下一个def关键字?

用例

说我正在写一个thor应用程序。理想情况下,我会这样记录它:

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行

yard_incorrect_source

为了获得正确的源输出,您需要将文档放在方法定义的顶部。 随着文档复杂程度的提高,这可能会成为一个问题,因为这会使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

yard_correct_source

环境详细信息

  • 操作系统:Ubuntu 16.04
  • Ruby版本:ruby 2.4.4p296
  • 围场版本:院子0.9.16

最后的笔记

我似乎找不到一种方法来配置码以忽略def之前的代码,或者跳过以desc开头的行。我找到的最接近的东西是https://github.com/lsegal/yard-thor,它似乎大部分没有记录且没有维护。

是否有任何码配置或插件可以让我将所有代码都保存在一起,并产生正确的源视图输出?

在源输出中包含desc调用以及方法定义的选项也将起作用。

0 个答案:

没有答案