ruby - :method: 符号应该为 ruby​​ 文档做什么？

Question

Minitest 有一堆方法定义如下：

  ##
  # :method: must_equal
  # See MiniTest::Assertions#assert_equal

  ##
  # :method: must_include
  # See MiniTest::Assertions#assert_includes

  ##
  # :method: must_match
  # See MiniTest::Assertions#assert_match

  ##
  # :method: must_output
  # See MiniTest::Assertions#assert_output

这些是在Object模块中定义的，因此它们可用于所有对象。但是为什么他们没有出现在任何文档中？我检查了 Yard on 生成的文档rdoc.info，以及rdoc我键入时生成的文档gem rdoc minitest。他们也没有出现。如果它们没有出现在任何地方，我应该如何引用它们？应该怎么:method:做？

Answer 1

这看起来像是一种记录未明确定义的方法的方式。在某些情况下，您可能想要添加关于动态生成的方法的注释，例如，或者从另一个模块加载的方法，例如这里的情况。