替代 rdoc 使用

Question

根据 这个帖子, RDoc::usage 目前在 ruby​​ 1.9 中不可用。有什么好的替代品吗？

我有兴趣了解标准安装中提供的功能以及 gems 中提供的功能。

Answer 1

我喜欢 选项解析器 （文章提到的事情 RDoc::usage 有助于补充）。

看起来像是 1.9 的 bug 已修补.

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