【コメント】doxygen【コンソメ】

【コメント】doxygen� ..

224:デフォルトの名無しさん
09/06/03 22:57:41 .net
追加で質問失礼。

Player.hの内容↓

/** @brief クラスの簡易説明
　*　このクラスの使用目的・使用方法など詳しい情報を書く。
　*　@todo 必要であれば記述
　*　@bug バグがあれば記述
*/

#if !defined (__PLAYER_H__)
#define __PLAYER_H__

class CPlayer
{
...
}

というプログラムだと、インクルードガードのほうに

マクロ定義
#define __PLAYER_INFO_BASE_H__
クラスの簡易説明　*　このクラスの使用目的・使用方法など詳しい情報を書く。

というドキュメントが付いてしまうのですが、
インクルードガードは一番上に書かなければいけないのでしょうか？

できればファイルに関するコメントを一番上に記述したいのですが・・・

次ページ

続きを表示

1を表示