どのようにドキュメントのレールを利用していますか？

Question

私は始めたばかりのドキュメントのレールを願います。ごきげんよう、トメ子です実際に行われるrdocうにしましたが、一部のrdocに関するガイド書式なった記述する属性のモデル検証の関係のモデルが多く、この問題についてこのActiveRecord.いうものがある場合、ガイドや実践についての文書は、レールの適用が何を知っていなければ不?

私がすべてこのクラスの説明が合うかなぁ方があり方と深く関わっており、宣言自体has_many,validates_presence_of等） いつ、どの属性?

Answer 1

個人的に好ヤード http://yardoc.org ので、良い仕事による記録まぁ.どうか分かりませんが特定のハンドラのためのレールが難に入する http://yardoc.org/guides/extending-yard/writing-handlers.html 良い例が、属性のハンドラの部分の庭の逸品:lib/ヤード/ハンドラ/ruby/attribute_handler.rb

Answer 2

記憶テストのドキュメント(開発者）は、特にご利用の場合はキュウリがシナリオます。だく方法は非常に短いが試験方法の記述名など"設定"ユーザー名"見た一般的なコメントの研究"に関するお問合せ

検証その他の部品をレールのないと感じています。一部のレールを開発者はこれらが仕事だと思うから公正な仮定も完全対的なヘルプオーサリング-ツールを持っていないことを知検証、またはその他のものに内蔵します。これと同じロジックが利用できるの枠組みは嬉しいパスを逸脱しないもの"文書化され]第三者コードの書類に書き込まれます。