ruby-on-rails - RDoc を使用して `:include:` ディレクティブを使用するには?

Question

私は Ruby on Rails 3.0.7 を使用しており、RDocを使用してアプリケーションのドキュメントを作成しています。Web 上で例を含む優れたドキュメントを見つけられなかったので、私が知りたいのは、:include:ディレクティブの使用方法です。

アプリケーションファイルでそれを使用する例を教えてもらえますか?

Answer 1

AIUI では:include:、インクルードが表示されるブロックの同じインデント レベルを維持しながら、別のファイルの内容を (驚くべきことに) インクルードできます。

現在のディレクトリで指定されたファイルを探しますが、これは--includeスイッチを使用してオーバーライドできます。

例が必要な場合は、これが役立つ可能性があります。

Answer 2

ドキュメントは次のとおりです。http://rdoc.rubyforge.org/RDoc/Markup.html

そして、ここに非常に基本的な例があります:

最初にRubyファイル、たとえば/tests/my_func.rb

#:include: doc.txt 

def my_function
  puts "yo"
end 

その後、ドキュメント/tests/documentations/doc.txt

This describes the method very well

コマンド ライン (から実行/tests):

rdoc -i /Users/benjaminroth/Sites/Tests/rdoc/descriptions