はじめてUNIXで仕事をする人が読む本 の備忘録 10 ソースコードからのドキュメントの生成

はじめてUNIX で仕事をする人が読む本 の備忘録 10

お世話になった本

この連載ブログを書くにあたり、お世話になった本がこちら。LPICと被っているところもありますが、実務での使い方なんかも扱っており、良書だと思います。

第10章 ソースコードからのドキュメントの作成

はじめに

ソースコードからドキュメントが作れると、2度手間もなく、ミスもなく出来ると思うからやってみよう。で出来たのがこの技術。

ドキュメント生成ツールの種類

いっぱい有ります。

  • Doxygen
    • 多言語対応のドキュメント生成ツール
  • Javadoc
    • JDKに付属するドキュメント生成ツール
  • PyDoc
    • Python に付属するドキュメント作成ツール
  • RDoc
    • Ruby に付属するドキュメント生成ツール

最近では言語処理系に標準でドキュメント生成ツールが付属していることが多い。

ドキュメント生成ツールの使用方法

Ruby のRDoc の公式ページの紹介だけします。

rdoc 4.1.1 Documentation


以上で、第10章 ソースコードからのドキュメント作成 は終わりです。
次回は、第11章 ソフトウェアライセンス です。