なぜ "：nodoc："構文が必要ですか？

Question

ライブラリ/プラグインの多くは、この構文を使用するようだ：

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

なぜ:nodoc:部分が必要なのか？

Answer 1

必要ありません。クラスに適用すると、クラス拡張のすべてのメソッドのドキュメント（rdoc）が表示されなくなります。

：としてプログラミングRubyで記述さnodoc： - は ドキュメントでこの要素を含めないでください。クラスと モジュールの場合、メソッド、エイリアス、 の定数、および影響を受けるクラスまたはモジュール内の直接の の属性 も、 のドキュメントから除外されます。しかし、デフォルトでは、 のモジュールとクラス またはモジュール内のクラスが文書化されます。

Answer 2

私はそれが必要ではないと思います。実際、私の意見では、これはRDocの最も役に立たない機能の1つです。

何度も、私はそれを見て、libarieのコードを読んでいたので、 "なぜ？"と尋ねなければなりませんでした。この機能を使用する理由は何もありません。人々にあなたの方法を使用させたくない場合は、それを非公開にしてください。ドキュメントを読んで、ドキュメントから抜け出したメソッドへのメソッド呼び出しを見ていると、大変な作業です。