Замена для использования rdoc

Question

Согласно этому посту , RDoc :: использование в настоящее время недоступно в ruby ​​1.9. Есть ли хорошие замены доступны?

Мне было бы интересно узнать, что доступно в стандартной установке, а также что доступно в гемах.

Answer 1

Мне нравится OptionParser (то, что в статье упоминается, что RDoc::usage полезно дополнить).

Похоже, что любые 1,9 ошибки были исправлены .

Answer 2

В запросе функции 2713 , сопровождающий rdoc заявил, что не будет добавлять rdoc / использовании или любую аналогичную функцию обратно в rdoc, заявив, что вместо этого следует использовать OptionParser.

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