Rubyベストプラクティス 第8章 上手なプロジェクトメンテナンス その3

第8章後半、RDoc についてのところです。

• RDoc による APIドキュメント生成
  • rdoc 自体の記述方や使いかたはレシピ本で読みましたね
  • 本書ではさらにドキュメントに何を書くべきかといった内容に踏み込んでいます
  • rdoc ディレクティブについて
    • プライベートなモジュールやメソッドには :nodoc: をつけてドキュメント化を抑制できる
    • ネストしたモジュール全てについて抑制するには :nodoc: all を使う。乱用には注意
    • :call-seq: を使うとドキュメントに表示するメソッドのシグニチャを変更できる
    • :section: ディレクィブでドキュメントをセクションに分けることができる

8章は 3回では終わりませんでした。もう少し続きます。