なぜ":nodoc:"文法が必要なの？

Question

そうで多くの図書館/プラグインはこの構文:

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

なぜそのような :nodoc: 一部必要ですか？

Answer 1

入力をする必要はありません。場合に適用クラスで抑制のドキュメント(rdoc)のためのすべてのメソッドはクラスです。に記載のプログラミングでRuby:

:nodoc: - 含めないでくださいこの要素 しています。のための授業 モジュールに別名 定数の属性を直接 の影響-クラスやモジュール も省略することから、 ます。デフォルトのもの モジュールとクラス内のこのクラス またはモジュールが記載されています。●

Answer 2

私はそれが必要だとは思いません。実は、私の意見では、それはRDocとのほとんど役に立たない機能の一つです。

libarieのコードを読みながら、私はそれを見てきましたし、私は自分自身に聞いていた「なぜ？」

だから、何度も。私はこの機能を使用するには何らかの理由が表示されません。あなたは人々があなたのメソッドを使用しない場合は、ちょうどそれが私的にします。これは、ドキュメントを読むとドキュメントの外に残っているメソッドにメソッド呼び出しを見て、大きな手間です。