ruby - 「:nodoc:」構文が必要なのはなぜですか?

Question

多くのライブラリ/プラグインがこの構文を使用しているようです:

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

なぜその:nodoc:部品が必要なのですか？

Answer 1

それは必要ない。クラスに適用された場合、Class 拡張機能のすべてのメソッドのドキュメント (rdoc) が抑制されるだけです。Ruby のプログラミングで次のように説明されています。

:nodoc: - この要素をドキュメントに含めないでください。クラスとモジュールの場合、影響を受けるクラスまたはモジュール内のメソッド、エイリアス、定数、および属性もドキュメントから省略されます。ただし、デフォルトでは、そのクラスまたはモジュール内のモジュールとクラスが文書化されます。