私がプログラミングをする目的は数値実験のためで、自分以外の人が私のプログラムを触る機会もほとんどなかったので、学生時代は、コーディング規約や保守性についてあまり意識が届いていませんでした。しかし、今の職場では他人が自分のコードを参照する可能性があるし、中長期で研究を行うことを考えると、コーディング自体の質を求めることも必要だなと思うようになりました。
という訳で、今日はソースコード上に書いたコメントを元に、ドキュメントを自動で生成してくれるツール「Doxygen」を導入して試してました。
導入
DoxygenのHPからインストーラをダウンロード。
ポチポチポチーっと進めて「doxywizard」をインストール。
コーディング
コメントで関数や引数の説明を書く。Intellisenseで参照もできる*1。
コメントの度に同じような雛形を打つのが面倒なので、コードスニペットを作ってショートカットで一発入力できるようにした。
↑こういう .snappet ファイルを作って、VC の「ツール」→「コードスニペットマネージャー」で確認したフォルダ内に配置。ショートカット＋Tab で雛形を一発入力。
ドキュメント生成
「Doxywizard」を立ち上げ、ドキュメントの出力先やソースコードの場所を設定。
色々と設定可能。ここではプライベートなメンバもドキュメントに載せるよう設定。
後は run してしばらく待つと…
ドキュメントが完成！
非常にお手軽で、かつちゃんとしたドキュメントができました！
これは便利なツール。今後とも使っていきますv(^^)
参考サイト
今日発売の森博嗣新作『天空の矢はどこへ？』。ヨドバシ.comで昨夜注文したら、朝には届いていました…相変わらず速すぎる！
