Doxygenコメントの紹介

どうも、大乱闘スマッシュブラザーズをDL版で購入した前田です。

最近は雑記ネタが多かったので、久しぶりに技術ネタを書きます。

二年生になると就職活動等で自分のソースコードを見せる頻度が多くなっていきますが、
会社によっては自分が制作したゲームよりもソースコードを重視する会社もあります。

ということで今回は、
ゲーム会社の人達も使用しているドキュメント自動生成ツール、
"Doxygen"を紹介します。

Doxygenは自分のソースコードに特殊なコメントを書くことによって、
自動でドキュメント化を行ってくれます。

Doxygenコメント例
//--------------------------------------------------
/// @brief テクスチャ読み込み
///
/// @param _sFilePath : 読み込み対象のファイルパス
/// @return  読み込み成功 = true / 失敗 = false
//--------------------------------------------------
bool LoadTexture( const std::string& _sFilePath );

詳しい書き方については以下のサイトを参考にしてください。
ゲームつくろー!

このDoxygenコメント、
自動でドキュメント化してくれるのもありがたいですが、
何よりコメント規則が統一されてソースが見やすくなるのが素晴らしいです。

もう少しで就職活動が始まりますが、
こういった所を工夫して、周りの人達と差をつけていきましょう！！

分からないところがあれば、
放課後のゲームラボⅠにて、GESリーダーをお尋ねください。

ではっ！！