Doxygen 주석 사용법

Item	설명
@author	작성자 이름을 나타낼 때
@brief	간략한 설명을 씀
@code	중요 코드를 설명할 때 시작 지점 설정
@date	작성날짜를 나타낼 때
@endcode	중요코드 설명할 때 종료 지점 설정
@exception	예외 처리
@file	파일 이름을 구별
@fn	함수를 나타낼 때
@param	함수 파라미터 표시
@remark	자세한 설명을 할 때
@return	함수의 리턴 값을 나타낼 때
@see	참고할 함수나 페이지 지정
@struct	구조체 정의
@bug
@mainpage
@section
@todo

File

/**

@file MainGame.cpp

@date 2012/07/03

@author LatinoHeat ( gamemyth99@gmail.com )

@version 1.0

@brief 메인게임 프로그램

*/

Function

/**

@fn int add( int a, int b )

@brief addtion funtion

@date 2012/07/02

@author LatinoHeat ( gamemyth99@gamil.com )

@param a 정수형 변수

@param b 정수형 변수

@return 더해진 값을 리턴

@exception

@remark 이 함수는 정수형 덧셈을 해주는 함수

*/

int add( int a, int b )

{

int result = a + b;

return result;

}

Struct

/**

@struct Info

@brief 정보를 위한 구조체

*/

struct Info {

int a /** @var int a 변수1 */

int b /** @var int b 변수2 */ };

Global Variable

int g_iSize; /** @var int g_Global 글로벌 변수 */

Define

#define MAXSIZE 100 /** @def MAXSIZE 최대 크기 */

#define SAFE_DELETE(p) { if(p) { delete (p); (p)=NULL; } }  /** #def SAFE_DELETE(p) p를 지워줌 */