問題タブ [rdoc]

多くのライブラリ/プラグインがこの構文を使用しているようです:

なぜその:nodoc:部品が必要なのですか？

ドキュメントがなくても gem をインストールできることはわかっていますが、残念ながら、Ruby を使用して最初の 3 か月間はインストールできませんでした。その間、私はかなりの量の gem をインストールすることができましたが、Ruby を使い始めて以来、自分のコンピューターでドキュメントを使用したことは一度もありませんでした。私はいつもインターネット上のドキュメントを見ています。

ドキュメントをコンピュータから安全に削除する最善の方法は何ですか? また、デフォルトでドキュメントをインストールしないように Ruby を設定する方法はありますか?

Rails プログラマーにとって、RDoc ファイルを最新の状態に保つ最も簡単な方法は何ですか?

手動で実行できることはわかっていますrake doc:appが、チェックイン プロセスに手動のステップを追加するのは本当に気が進まないので、既にCruisecontrolrbを使用して展開とテストの自動化を処理しているため、簡単な方法があるはずです。チェックイン時にこれらのファイルを再生成します。

誰かがすでに自動化していますrake doc:appか? もしそうなら、あなたの提案は何ですか？

プロジェクトの readme ファイルを作成するために Textile または Markdown を使用するのが好きですが、RDoc を生成すると、readme ファイルが RDoc として解釈され、非常に見栄えが悪くなります。独自のフォーマッターではなく、RedCloth または BlueCloth を介して RDoc でファイルを実行する方法はありますか? ファイルのサフィックスからフォーマットを自動検出するように構成できますか? (例: README.textile は RedCloth を介して実行されますが、README.mdown は BlueCloth を介して実行されます)

RDoc 内のファイルのドキュメントにリンクしたいと考えています。しかし、私ができる唯一の方法は、次のマークアップを使用することです:

次のような、より良い方法でやりたいと思います。

これを行うための既存のマークアップ規則はありますか?

編集:もちろん、このようなマークアップなしで試してみましconfiguration.rbたが、リンクなしでファイル名が表示されます:(

変更されていないすべてのファイルを再度含めるように rdoc に指示するパラメーターはありますか?

rdoc を 2 回 (3 回、4 回) 呼び出すと、変更されたファイルが解析され、index.html はこの解析されたファイルの内容のみを表示します。他のファイルはサブディレクトリで引き続き使用できますが、表示されていません。

簡単なことかもしれませんが、解決策が見つかりません。

ヒントをありがとう... :)

Rails 上でオープンソースの Web アプリケーションを開発しています。コードをできるだけ理解しやすく、変更しやすいものにしたいと考えています。私は単体テストで開発をテストしています。コードの多くは、テスト ケース (各コントローラー アクションが入力として期待するもの、出力用に設定されているインスタンス変数、ヘルパーの呼び出し方法、ビジネス ロジック) を通じて「文書化」されています。モデルに組み込まれているなど）。それに加えて、Rails の規則により、私のコードが規則に準拠している場合、多くのドキュメントが不要になります。

では、十分に文書化された Rails アプリケーションを持つことと、Don't Repeat Yourself に従おうとすることのバランスはどこにあるのでしょうか? Rails アプリで本当に役立つ (RDoc) ドキュメントと、単なる無駄とは何かについてのガイダンスが記載された、優れたブログや記事はありますか?

gem環境のデフォルトのRDocテンプレートを変更するにはどうすればよいですか。

私のgemサーバーを次のRDocのようにしたいと思います：http：//getcloudkit.com/api/そして私はそのデザインを見てきましたので、これはそれほど難しいことではありません。

Railsのドキュメント、そのプラグイン、およびアプリを、ナビゲートできる1つのファイルに生成するための最良のオプションは何だろうと思っていました。私は rdoc を使用してきましたが、複数のファイルが作成され、ヤードが遅すぎてハンナがランダムな場所で動かなくなります。何か助けはありますか？

私は自分の Rails プロジェクトでYARDを使用していますが、Rails モデルで継承されたメソッドやランタイム メソッドをどのように文書化するのだろうかと考えていました。たとえば、モデルのfirst_name属性の存在を文書化します。User