Simplestar Game

:::::::::::022話　Doxygen形式のコメントとデバッグ:::::::::::

ゴールデンウィークは毎日のように更新が続きます。どうも、星姫です。
今回はコードを書く上で必要になるコメントの書き方とデバッグの基本を学びます。

さて、プログラマーにとって3ヶ月後の自分は他人です。
他人に見せるプログラムとは、これまでのプログラムと何がどう違うのでしょうか？
日ごろからどんなコードを書けばよいのかを考える回です。

ここのところ真面目に描いていたので、ここで一発書きの手抜きイラスト。
高校2年生の時に「ヒカルの碁」を知って、囲碁にはまりました。
母親も気に入ったらしく、協力してヒカルの碁の単行本を全巻揃えました。
父親は囲碁を元々知っていたのですが、あるとき対等に戦えるようになったところで
父親が相手をしてくれなくなったのがちょっと寂しかったです。

さて、本題に入ります。
みなさんDoxygenって聞いたことありますか？私は職場の研修で初めて知りました。
ググってみると以下の公式ページに行きつくと思います↓

「Dogygen」

英語のサイトが本家ですが、日本語のサイトもあるのでみなさんは安心するかもしれません。
ですが安心するのはまだ早いです、問題は言語の壁では無いのです。

前回のアドインのインストールを問題なく出来る人も、Doxygenの導入は簡単にはいかないはず。

なぜなら、たくさん設定することがあって、初めてTeXを導入するような難しさがそこにはあるからです。
TeXも知らない？　TeXは大学生になって論文を書くようになると使う論文作成ツールみたいなものです。

博士過程の方でTeXを使って論文を何度も書いている先輩が、PCを新しく購入した時に
TeXを導入するのに丸一日かけてしまったという事件がありました。
はぁ、そういったすぐに使えないソフトは嫌いなのですが、今回はちょっと我慢して設定方法を調べてみました。

便利なのはいいことなんだけど、こうワンプッシュで導入出来ちゃうようなものが一般に広まらないのはどうしてなんでしょうか？

前置きが長くて申し訳ない。ここから本題に入ります。

最初は本家からDoxygenをインストールします。
…インストールするファイルもいくつかあるけど…まぁ、「これだよね」と思うものを選んでみました。
私のPCの環境から考えて、「A binary distribution for Windows XP/Vista/7」をダウンロードしました。
この時点で、間違っているかもと考えて、ちょっとイライラした。

インストールはよく見かける形式だったので「次へ」と「同意」ボタンの連発でこんな感じでフォルダが増えます。
画像は「すべてのプログラム」のものです。

で、ここからが面倒なのです。動作を確認することはできますが、すぐには使えません。
とりあえず動作確認から行ってみましょう。
インストールされたフォルダを確認してください。
ディフォルトではC:/Program Files/doxygen になると思います。
その中はこんな感じ↓

動作確認の仕方は、まずbinフォルダの中のdoxygen.exeに
コードが書かれたファイルをドラッグ&ドロップするだけです。

こうやってcppファイルをドラッグ&ドロップすると…
あ、このコードは第20話のクラステンプレートのやつです！

ドロップしたファイルのカレントディレクトリに赤枠で囲ったように二つのフォルダが現れます。
htmlフォルダのindex.htmlを開くと以下のようなコードの説明が見られます。

も、文字化けしてる。これらの問題を解決する設定操作をこれから説明していきます。
とりあえず、動いてよかったです。
ソースコードからコードの説明文書を作れるので、これは便利だと思いますよ。

ではコマンドプロンプトを開いてください。この辺は説明なしでも大丈夫かな？
>doxygen -g
とコマンドを打ち込みます。

すると、英語で説明を受けた通りDoxyfileが作られます↓。

これを開きます。（プログラムを指定して開く…とかで、ワードパッドかメモ帳で開きます。）
画像はワードパッドで開いてみた状態です。
スクロールバーに注目すると設定ファイルがとても長いことに気づきます。

これの設定をどうすりゃいいの？…で、参考にしたのが以下の二つのサイトです。
図の赤枠で囲ったところの変更内容について参考になる情報が記載されています。

文字化け対策がここ↓
「僻地のプログラマkmt-t - わりとどうでもいい日記 1.1 doxygenの文字化け対策 2009-04-03」
その他の変更がここ↓
「doxygen - ゾイの備忘録Wiki」

私は両サイトの情報を参考に以下の変更をDoxyfileに対して行いました。

さて、検索機能を使って、効率よく上記の変更を加えたなら、INPUT で指定したフォルダに対象となるソースファイルを入れます。
ファイルは先ほど動作確認で使用した第20話のクラステンプレートのコードを使いました。

さて、やっと準備が整いました…後はdoxygenを実行するだけです。
doxygenを実行するには、コマンドプロンプトへ
>doxygen
と打つだけです。

すると処理が進んで

指定した出力フォルダ（ここではOUTPUT_DIRECTORYで設定したC:/Users/simplestar/Doxygen）に
以下のようにフォルダが作成されます。

例のhtmlフォルダがありますね。Errorlog.txtの内容を確認したら、さっそくhtmlフォルダ内のindex.html を開いてみましょう。
Doxygen.chmがある人は、そのファイル一つでもOKです。
以下のファイルが文字化け対策＆フォルダ指定によるDoxygen実行結果のindex.htmlです。

「Doxygen Sample 1.0 index.html」

あのソースコードからこんなドキュメントが作れました。
え？今さらですがdoxygenの読み方ですか？　確か「ドキシジェン」です。

しっかし、Doxygenのインストールって手間ですねぇ。
うーん、ソースのほかにドキュメントを用意する手間が省けたと思えば良いのかな。
とにかく導入出来てほんと良かったです。
さて、気になるDoxygen形式でのコメントの書き方はこちら↓

とりあえず何を書けばよいのか↓
「コメントの書き方(クラス・関数のコメント)」
書き始めた時に気になる詳細↓
「Doxygen 特殊コマンド」

あとは、私がこれから書いていくコードを参考に覚えていく感じでいいと思います。
良く使うコマンドが定番になるだけかと思いますので…さて、次はデバッグについて勉強してみましょうか！

まずは、参考に以下のリンクに目を通してみてください。

「最初にマスターしたいVisualStudioのデバッグ機能-基本編」

「最初にマスターしたいVisualStudioのデバッグ機能-応用編」

こちらはVisual Studioのデバッグ機能についての紹介です。
品質の向上と開発期間の短縮のためのVisual Studioの機能を有効に活用する手引きといったところでしょうか。
わ、解りやすいですね！
もはや解説の必要なし、青木先生に感謝です。ありがとうございました！！
最新の情報をチェックしたいなら、こちらを参照とのことですね↓。

「Visual Studio でのデバッグ」

次回は3D数学の基礎を勉強してみます。
そろそろ、動くものをみんなにお見せできるのではないでしょうか？
それではまた次回、お楽しみに！

2010/05/04 初記．
2010/05/06 修正。