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

看来很多库/插件使用这种语法：

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

为什么：nodoc：part part？

解决方法

没有必要.如果应用于一个类,它只会抑制Class扩展中的所有方法的文档(rdoc).在编程Ruby中描述为：

:nodoc: – Don’t include this element in the documentation. For classes and modules,the methods,aliases,constants,and attributes directly within the affected class or module will also be omitted from the documentation. By default,though,modules and classes within that class or module will be documented.