どのように私は表示Rubyスクリプトヘルプ/利用状況情報にRDOCとのreadmeファイルを処理します

Question

私は私のスクリプトの先頭に代わり、コメントのreadmeファイル（当たり前）で、私の使用状況documenationを維持したいと思います。どのように私は、スクリプトのコメントの代わりに、Readmeファイルのうち、使用情報を引き出すためにはRDoc ::使用を得るのですか？

Answer 1

のRDocは、ソースファイルを解析するために設計されたコメントとその場所を見て、変数のビルド相互参照、および、終了したら、すべてのまともな出力にそれを結ぶれます。 RDocとは、ソースファイルに対して動作するように設計されているので、それはあなたがやりたいことのために最良の選択ではないかもしれません。

その代わりに、タグベースであるヤードに、に見たいと思うかもしれません。 は私が適切な形式で自分のRDocに私README.textileを得ることができますか？のは、あまりにもあなたのためにいくつかの有用な情報を持っています。

クラスとメソッドのスタブと一緒に

あなたが望むようにあなたは、アプリがREADMEタイプのドキュメントを解析するために得ることができない場合はいずれの場合も、ファイルにすべてのドキュメントを置くことによって、それを偽装することができるかもしれないので、パーサは、彼らが使用可能なドキュメントを作成するために必要なパラメータ、グローバル、およびその他「その他もろもろ」をつかむことができます。

それ以外の場合、あなたはおそらく、自動化されたヘルプを使用して断念し、すべてでそれを入力する必要があります。

私の推薦はそれをあなたのコードの内部のRDocの方法、およびドキュメントを行うことです。それはすべてで行うことは難しいことではありませんし、出力は非常に良好なものとすることができます。それは良い仕事のRDocを行うことができますどのようにかなり驚くべきことだ。

Answer 2

私は確かにあなたに答えを伝えるために、経験豊富な十分ではないんだけど、私にアドバイスを1つ許可してくださいます。

開発者のほとんどは今までそれが実装上のコードの3行だ場合でも、ドキュメントを更新する可能性は低いです。

好意を行い、プロセスがさらに困難にしないでください。

別の一般的なドキュメントを維持するにはかかわらず、素敵なアイデアですが、それはとにかくあなたのRDoc、生成される出力には何の関係もありません。