Doxygen 주석 사용법
Doxygen 주석 명시
/* 일반주석 ..주석 내용.. */
/** Doxygen 주석 ..주석 내용.. */
주석 Item
Item | 설명 |
---|---|
@author | 작성자 이름을 나타낼 때 |
@brief | 간략한 설명을 씀 |
@bug | |
@code | 중요 코드를 설명할 때 시작 지점 설정 |
@date | 작성날짜를 나타낼 때 |
@endcode | 중요코드 설명할 때 종료 지점 설정 |
@exception | 예외 처리 |
@file | 파일 이름을 구별 |
@fn | 함수를 나타낼 때 |
@mainpage | |
@param | 함수 파라미터 표시 |
@remark | 자세한 설명을 할 때 |
@return | 함수의 리턴 값을 나타낼 때 |
@section | |
@see | 참고할 함수나 페이지 지정 |
@struct | 구조체 정의 |
@todo |
File
/** @file Main.c @date 2011/06/23 @author WooSeung Lee (fornamoo@gmail.com) @version 1.0 @brief 메인 프로그램 */
Function
/** @fn int func(int a, char b) @brief test function @date 2011/06/23 @author WooSeung Lee (fornamoo@gmail.com) @param a 정수형 변수 @param b 문자형 변수 @return result는 결과 값 리턴 0은 실패 1은 성공 @exception EACCES 파일 접근 에러 @remark 이 함수는 테스트용 합수입니다. */ int func(int a, char b) { int result; return result; }
Structure
/** @struct list @brief 리스트를 위한 구조체 */ struct list { /** @var int m_a 멤버 변수1 */ int m_a; /** @var char m_b 멤버 변수2 */ char m_b; };
Global Variable
/** @var int size 크기 변수 */ int size;
Define
/** @def BUFSIZE buffer size */ #define BUFSIZE // buffer size /** @def MAX(x,y) x값과 y값을 비교하여 더 큰 값을 리턴 */ #define MAX(A,B) ((x)>(y)?(y):(x))
이 글은 스프링노트에서 작성되었습니다.
참고 포스팅을 위하여 Item 내용을 스크랩해가겠습니다. *^^*