39


1

RubyでRDocに既存のコメントを追加するにはどうすればいいですか?

私の既存のコメントを 'RDocコメント’としてフォーマットしたいので、それらは `ri`を使って見ることができます。

RDocを使い始めるための推奨リソースは何ですか?

2 Answer


14


噛んだことがいくつかあります。

  • :main:-RDocは最後に評価されたもののみを使用します。確認するのが最善 プロジェクトには1つしかなく、コマンドライン引数 `--main`も使用しません。

  • 以前と同じですが、 `:title:`の場合

  • `:section:`はあまりうまくいきません


9


RDocはSimpleMarkupを使用するので、リストなどを作成するのはかなり簡単です。 *、 - 、または数字を使用します。 また、新しい段落を表す空行があるまで、同じ段落の一部として同じ列番号でインデントされている行も扱います。 RDocしたいコメントの例がいくつかありますが、その方法を紹介してから、それを残りのコメントに適用できますか。