2011年05月19日

Doxygenを使ってみた @ Mac

img1

以前から知っては居たけど、まともに実践投入してなかったんだけど、Doxygenを使ってみました。

実は、随分前から開発が途切れつつ続けているモノが有って、流石に、間だが頻繁に空いたりすると、色々と忘れてしまっている事もあったりして、毎回開発再開する前に整理が必要。その度に、あれこれ修正したくなったりして全然進まない。こんな事の繰り返し。そんなわけで少しでも、開発の補助にでも成ればと思って、Doxygenを使おうと思ったわけです。

まずは、インストール。と思って、ソースコードをダウンロードして、configureしてmakeしている途中で、Mac用のバイナリーがある事を発見。make installしないで、そちらを使う事にしました。このバイナリー、コマンドラインのツールをインストールする者かと思ったら、違ってた。よく見るとダウンロードするページにも、GUIフロントエンドを含んでいると書かれてあった。以前見た時も完全に見落としていたよ。正直、設定ファイルとか、コマンドラインで実行とか面倒だなと思って、使ってなかったDoxygenですが、一気にハードルが下がった感じがする。

Doxygen.appを起動すると、ウィザードで一つ一つ必要なところを設定していけば簡単に使い始める事が出来ます。エキスパート(Expert)メニューでは、細かな設定が出来ますが、最初は多分必要なし。ウィザード(Wizard)メニューで変更した箇所は赤く表示されたりするので、変更したところも判りやすい。設定が出来れば、RunメニューでRun doxygenするだけ。

ただ単に、ソースコードをそのまま使っても良いのですが、やはりDoxygenに適したコメントを書くと便利です。幾つか記述方法があり、迷いましたが、取りあえずこんな感じの奴をXcodeのスニペットに入れておく事にしました。

/*! @brief 概要説明

詳細説明
@author keiso
@bug バグですよ。
@warning 警告ですよ。
@todo やる事を記述
@param パラメータ
@return リターン
*/

あと、 使用している変数の説明を何処に書くのか、実は迷いましたが、@interfaceの中は@privateにする事がよくあるので、@propertyの方に記述する事にしました。実はデフォルトだと@privateが出力されない設定(EXTRACT_PRIVATE = NO)となっているので、エキスパート(Expert)メニューで変更しました。実はこれ、何処にあるのか迷いました。GUIだと何処にあるのか検索が難しいので、探してしまった。(Buildの中にありました。) 変数の後ろに以下の様な記述をします。

/*!< プロパティの説明 */

その他、ヘッダーファイルにはこんな感じのコメントを入れる事にしました。(この辺は毎回書いているのは面倒な気もするので、Xcodeのテンプレートを書き換えた方が良いかも。) 以下の記述をソースコードの上の方に入れておくと、HTML出力した時のクラス>構成ページに、一覧に説明としてbriefの内容が表示されます。

/*!
@brief データ入力用ビューのコントローラ
@author keiso
@date 2011/04/22
*/

以上が基本的な事かなと思いますが、個人的に一番便利だと思った部分が、 @todoです。@testや@bugなどを書いておけば、関連ページに「テスト一覧、TODO一覧、バグ一覧」が表示されるので、あちこちに散らばって書いていても、視認性が良いです。Xcodeにも #pragma mark TODO: で記述する事は出来るのですが、一覧表示は無かった気がします。エディター上部のパンぐずナビ風の所に表示されて、そこで一つのソースコード無いならばぱっと見やすくはなりますが、それ以上の恩恵はないと思います。もしかして、知らないだけで何処かでプロジェクト全体を一覧出来たりする?出来るならば嬉しい。ただ、そうなるとどちらで記述するか悩ましいところです。Xcodeが// TODO: の形式も認識するようなので、// @todo:などを書いたら認識しないかなと思っていろいろと試したりしていたらXcodeが落ちました。(笑)

それにしてもなぜにDoxygen.appのアイコンは、麺が入った器の下に手回しが付いた台があり、そこからテキストが出て来ているのだろう。器に入っている意味が分からない。だったら、もう少しパスタメーカーとして判りやすくした方が良いのでは?器に入っていたり、下の台はパスタメーカーから離れすぎている気がする。

Doxygen
>>関連リンク

閲覧数: 3301 / はてなブックマークusers

関連商品

amazon.co.jp・詳細ページへ

blog comments powered by Disqus

関連日記

アマゾン広告

この日記ページは閲覧数などの条件に応じて、閲覧制限を行っています。他からリンクしていただいても、そのリンクから辿った閲覧者が当ページの内容をご覧頂けない場合があります。ご了承下さい。

▼日記検索

Mac

Shade

3D

Flash

ゲーム

ウェブ

音楽

映画

デジカメ

Windows

Linux

携帯電話

テレビ

広島

電子工作

iOS

▼ 最近のトラックバック

▼ランキング

▼関連サイト