Takahiro Octopress Blog

-1から始める情弱プログラミング

Xcode6.2で使ってみようDoxygen

| Comments

Doxygen

さて、本日はDoxygenについて書こうと思います。
筆者はAppleライクなリファレンスを生成できるappledocを利用していましたが、なぜかXcode6.2でうまく生成できないことやAppleの公式リファレンスのデザインが以前より大幅に変更されたことからDoxygenを使うことにしました。

DoxygenはC++, C, Java, Objective-C, Python, IDL, Fortran, VHDL, PHP, C#のためのドキュメントジェネレータツールです。
独特のリファレンススタイルであるものの、下記3点のメリットがあると公式サイトに書かれています。

  • ドキュメントとソースコードの一貫性を保つことが容易
  • 文書化されていないソースファイルから、 コードの構造を抽出するように設定可能
  • Doxygen を「乱用 (abuse)」して、 通常のドキュメントを作成可能

では、早速使ってみることにしましょう。

Doxygenの使い方

まず、Doxygen公式サイトからダウンロードしましょう。
PCへのインストールが完了すると、下記のウィンドウが表示されます。
Doxygen.app

ドラッグ&ドロップでApplicationに追加しましょう。

Doxygenを起動します。
すると下記のようなウィンドウが表示されます。
Doxygenウィンドウ

各項目を下記のように指定しましょう。
Doxygenウィンドウに各項目を指定

そして、Runをクリックしてタブを切り替えます。そして、Run doxygenをクリックします。
すると、Output produced by doxygenにログが出力されます。

ログを出力

完了したら、 Show HTML output をクリックしましょう。
ブラウザが起動して、リファレンスが表示されるはずです。

リファレンス

クラス間の関係性もわかるため、なかなか良い気がします。
appledocとほとんど書式も同じっぽいですし。
少しずつ慣れていこうと思います。
といったところで今日はここまで。

Comments