<< Doxygen Quick Guide >>
*Doxygen 기본 스타일
/** */
*주석안에 아이템들
@breif ==> 설명을 쓴다. 여러줄을 쓸때에는 @breif를 쓰고 한줄 띄운다움 계속해서
쓰면된다.
@file ==> 파일 이름을 구별할때.
@return ==> 함수의 리턴값 나타낼때.
@author ==> 작성자 이름을 나타낼때
@date ==> 작성날짜를 나타낼때.
@param ==> 함수 파라메터를 나타낼때
@see ==> 참고할 함수나 페이지를 지정한다.
@todo ==> 다음에 작업해야 될 내용
@bug ==> 버그에 대한 기술
@code ==>중요 코드를 설명할때 시작 지점 가리킨다.
@endcode ==> 중요코드 설명할때 종료 지점 가리킨다.
@exeception ==>
@mainpage ==> Doxygen 메인 페이지
@section ==>
@version ==> 버전 설명
@warning ==> 경고
====클래스 처리===
@class ==> 클래스명 나타낼때.
*클래스 멤버에대한 처리
/// 이렇게 표시한다.(단 멤버 상단에 표시할것!!)
/**< 내용 */ 이렇게도 표시한다. (멤버 옆에)
///< 이렇게도 표시한다.(멤버옆에)
====enum 타입처리====
*상단에 @brief로 무엇을 하는것인지 나타내고
각각의 멤버에 대해서는.
/*!< 내용 */ 이렇게 표시한다. (멤버 옆에)
/**< 내용 */ 이렇게도 표시한다. (멤버 옆에)
///< 이렇게도 표시한다.(멤버옆에)
===중요 코드도 주석을 단다.===
@code 로 시작해서
@endcode 로 끝낸다.
예제1)
/**
* @brief 예제코드
*
* 추가설명
* @code
*........
* @endcode
*/
예제2)
/// @mainpage doxygen 테스트 예제용 메인페이지
/// @section intro 소개
/// - 소개 : doxygen 을 사용하는 방법 설명
/// @section Program 프로그램명
/// - 프로그램명 : doxygen test sample
/// - 프로그램내용 : 화면에 Hello World!을 출력한다.
/// @section CREATEINFO 작성정보
/// - 작성자 : infiniterun
/// - 작성일 : 2005/04/18
/// @section MODIFYINFO 수정정보
/// - 수정자/수정일 : 수정내역
/// - infiniterun/2005.0418 : "Helo World"에 "!"추가
