为什么需要":nodoc:"语法？

Question

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

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

为什么这个:nodoc:部分是必要的？

Answer 1

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

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