スクリプトの先頭にあるコメントではなく、使用方法のドキュメントを readme ファイル (duh) に保存したいと思います。RDoc::usage を取得して、スクリプト コメントの代わりに readme から使用情報を取得するにはどうすればよいですか?
2 に答える
1
RDocは、ソースファイルを解析し、コメントとその場所を確認し、変数の相互参照を作成し、完了したら、すべてを適切な出力に結び付けるように設計されています。RDocはソースファイルに対して機能するように設計されているため、実行したいことに対して最良の選択ではない場合があります。
代わりに、タグベースのヤードを調べることをお勧めします。README.textileを適切なフォーマットでRDocに取り込むことはできますか？あなたにも役立つ情報があります。
いずれの場合も、アプリでREADMEタイプのドキュメントを必要に応じて解析できない場合は、すべてのドキュメントをクラスとメソッドのスタブとともにファイルに入れて、パーサーが取得できるようにすることで、アプリをスプーフィングできる可能性があります。使用可能なドキュメントを作成するために必要なパラメータ、グローバル、およびその他の「whatnot」。
それ以外の場合は、自動ヘルプの使用をやめて、すべて入力する必要があります。
私の推奨は、それをRDocの方法で行い、コード内に文書化することです。難しいことではなく、出力は非常に満足のいくものになります。RDocがどれほど優れた仕事をすることができるかはかなり驚くべきことです。
于 2010-11-28T05:35:40.110 に答える
0
私は確かにあなたに答えを言うのに十分な経験がありませんが、私に一つのアドバイスをさせてください。
ほとんどの開発者は、実装より3行上のコードであっても、ドキュメントを更新する可能性はほとんどありません。
賛成して、プロセスをさらに難しくしないでください。
一般的なドキュメントを分離しておくことは良い考えですが、とにかくRDocで生成された出力とは何の関係もありません。
于 2010-11-18T14:09:07.230 に答える