为什么需要“：nodoc：”语法？

Question

似乎很多库/插件都使用这种语法：

  def self.included(base) # :nodoc:
    base.extend ClassMethods
  end

为什么需要:nodoc:部分？

Answer 1

没有必要。如果应用于类，它只会抑制类扩展中所有方法的文档（rdoc）。在Ruby编程中描述为：

  

：nodoc： -   不要包含此元素   文件。对于课程和   模块，方法，别名，   常量和属性直接   在受影响的类或模块中   也将省略   文档。但是，默认情况下，   该类中的模块和类   或模块将被记录。

Answer 2

我认为没必要。实际上，在我看来，这是RDoc最无用的功能之一。

我在阅读libarie的代码时已经看过很多次了，我不得不问自己“为什么？”。我认为没有理由使用此功能。如果您不希望人们使用您的方法，请将其设为私有。阅读文档并查看对文档中遗漏的方法的方法调用时，这是一个很大的麻烦。