既存のコメントを「RDocコメント」としてフォーマットして、ri
を使って表示できるようにします。既存のコメントをRubyのRDocに追加するにはどうすればよいですか?
RDocを使い始めるのにおすすめのリソースはありますか?
既存のコメントを「RDocコメント」としてフォーマットして、ri
を使って表示できるようにします。既存のコメントをRubyのRDocに追加するにはどうすればよいですか?
RDocを使い始めるのにおすすめのリソースはありますか?
RDocはSimpleMarkupを使用しているため、*や - を使用してリストなどを作成するのは簡単です。また、同じ段落の一部と同じ列番号にインデントされた行は、新しい段落を示す空の行があるまで処理されます。あなたは、あなたがそれらを行う方法を示すことができるようにRDocされているコメントのいくつかの例がありますか?そして、あなたはコメントの残りの部分を推論することができますか?
私をかましてきたいくつかのこと:
:main:
- のRDocが評価最後のものだけを使用しています。プロジェクトに1つしかないことを確認し、--main
コマンドライン引数も使用しないことをお勧めします。:title:
:section:
のために非常によく
働く[ドキュメント]に見てみましょうしない(http://docs.seattlerb.org/rdoc/) – Tobias