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

Question

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

Мне было бы интересно услышать, что доступно при стандартной установке, а также что доступно в gems.

Answer 1

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

Это похоже на любые ошибки 1.9 были исправлены.

Answer 2

В запрос функции 2713, сопровождающий rdoc заявил, что он не будет добавлять rdoc / usage или любую подобную функцию обратно в 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