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

Question

这似乎是一个很大的库/插件使用以下语法：

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

为什么:nodoc:部分必要？

Answer 1

这是没有必要。如果应用于类，它只是抑制在类扩展所有的方法文件（的RDoc）。在编程红宝石描述为：

  

<强>通过：nodoc： -   不包括在此元素   文档。对于类和   模块，所述方法，别名   常量和直接的属性   受影响的类或模块内   也将被从省略   文档。默认情况下，虽然，   该类中的模块和类   或模块将被记录。

Answer 2

我不认为这是必要的。其实，在我看来，它是RDoc的最没用的功能之一。

所以，很多时候我已经看到了，而读一libarie的代码，我不得不问自己：“为什么？”。我看不出有任何理由要使用此功能。如果你不想让别人使用你的方法，只是将其变为私有。这是一个大麻烦阅读文档，看到一个方法调用剩下的出来的文档的方法时。