RDOCを使用するための交換

Question

によると、このポストに、RDocの::使い方ルビー1.9で現在利用できません。何か良い代替品はありますか

私は標準から何が宝石から利用できるだけでなく、インストール可能な何聞いて興味があると思います。

Answer 1

私は（はOptionParser の好き事は記事がRDoc::usage）を補完するために有用であることを言及していること。

これは、任意の1.9のバグ<のhref = "http://redmine.ruby-lang.org/search/index/ruby-19?q=optparse+1.9&issues=1&changesets=1&wiki_pages=1&all_words=1&titles_only=1&submitのように見えます=「のrel = "nofollowをnoreferrer">を提出にパッチが適用されています。

Answer 2

機能要求2713 のでは、RDOCのメンテナは、彼が勝ったと述べています「TはOptionParserの代わりに使用すべきであると言って、RDOC /使用方法やバックRDOCに任意の類似した機能を追加します。

Answer 3

私たちは、すべての新しいスクリプトのためのOptionParserを使用していますが、およそ100 +のRDocを使用したことがありました。代わりに書き換えそれぞれの私は（BBは、当社の名前空間です。何が好きにそれを変更）このメソッドを書きました。それは素晴らしい作品。構文は多少異なりますが、そのヘルプテキストは、私たちは気にしません。それが役に立てば幸い！

私は、すべてのスクリプトを見つけ、それらを変更するためにsedを使用します。

grep -rl "RDoc::usage" * | xargs sed -i "/rdoc\/usage/ s/RDoc/BB/"
grep -rl "BB::usage" * | xargs sed -i "/rdoc\/usage/ s/rdoc/lib\/bb/"

-

module BB
    def BB::usage( exit_code )

        File::open( $0, 'r').readlines.each_with_index do | line, idx |
            next if idx == 0
            if( line =~ /^#/ )
                puts line.gsub(/^#\ ?/,'')
            else
                puts #RDoc adds extra line so we do too
                exit( exit_code )
            end
        end
    end
end