[Doxygen] Doxygen 사용에 따른 주석 기입 형식

2 Doxygen 형식

2.1          소스 파일의 최상단에 파일명, 날짜, 제작자, 설명등을 명기한다.
(주석의 방식이/**, */인것에 주의한다. h, inl, cpp등 모든 소스파일에 표기한다.)
예)
/**    
          @file      RHttp.h
          @date    2004/11/2
          @author 개똥이

             RapidEngine™
          @brief
*/

2.2          클래스 및 구조체 인터페이스 윗부분에 클래스명, 날짜, 제작자, 설명등을 첨부한다.
(주석의 방식이/**, */인것에 주의한다.)
예)
/**
          @class  CRHttp
          @date    2004/11/2
          @author 개똥이 

                    @brief    Http 클라이언트
          @warning 몇몇 서버상의 오류로 가능한 업로드는 소문자로 한다. (특히 하나포스 마이홈)
*/
class CRHttp
{
                       …
};

2.3          클래스 / 구조체 멤버 변수 주석은 공백 1칸을 띄우고 “///<” 를 사용한다.
예)
long m_lFrameTic; ///< 1000/fps로 이시간후 (ms) 프레임을 이동한다.
long m_lNewTime; ///< 최종 프레임 진행 시간

2.4          클레스 멤버 함수는 헤더에 “///<”을 사용하고 추가 설명, 리턴값 및 인자에 대한 필요하다면 구현부분에 추가 설명을 입력한다.
선언부 예)
DWORD* Decode( DWORD* pBuffer, DWORD* pSize ); ///< 암호화 버퍼와 변경된 size리턴 (4바이트 증가)

구현부 예)
/**
          @return 찾은 그룹  (없으면 NULL)
          @warning 외부에서 관련된 동기화 객체를 Lock을 걸어 사용한다.
*/
CRGroup* CRServer::FindGroup( RGID gid ///< 그룹 아이디
                                                 )
{
}

2.5          일반 함수는 헤더에 “///”을 사용하고 추가 설명, 리턴값 및 인자에 대한 필요하다면 구현부분에 추가 설명을 입력한다.
선언부 예)
/// 하위폴더 포함하여 디렉토리를 생성한다.
extern BOOL CreateXDirectory( LPCTSTR szPath );

구현부 예)
/**
          @return 디렉토리 생성 성공유무
          @warning King\kong\file.dat와 같은 파일명은 포함 안된다.
 */
BOOL CreateXDirectory( LPCTSTR szPath ///< 생성할 디렉토리명 (예:C:\\King\\kong, King\\kong\\)
                                    )
{
}

3  일반 형식

3.1          주석은 설명하는 구문의 앞 라인에 작성한다.
올바른 예)
// 파일의 크기가 설정되지 않았다면…
if( nSize == 0 )
{
          return  FALSE;
}

잘못된 예)
if( nSize == 0 ) // 파일의 크기가 설정되지 않았다면…
{
          return  FALSE;
}

if( nSize == 0 )
{        // 파일의 크기가 설정되지 않았다면…
          return  FALSE;
}