1.파일
/**
@file main.cpp
@date 2009/04/25
@author 홍길동(hong@aaa.com)
@brief 프로그램의 구동
*/
2.클래스
해당 클래스 선언부 위에 위치한다.
/**
@class main.cpp
@date 2009/04/25
@author 홍길동(hong@aaa.com)
@brief 프로그램의 구동
@warning 주의 사항이 있으면 이 곳에 입력한다.
*/
3.함수 설명
해당 함수 위에 위치한다.
/**
@return char * : 이름
@param strPersonNum : 주민등록번호
@brief 해당 주민등록번호의 이름을 가져온다
@warning 주민등록번호는 - 없이 입력한다.
*/
4. 간략설명
해당 라인의 뒤에 위치한다.
unsigned logn nAssetIP; ///< 자산 아이피
또는
unsigned logn nAssetIP; /**< 자산 아이피 */
5.주석 내 사용되는 item 들
@breif 간략한 설명을 쓴다.
@remarks 자세한 설명을 쓴다.
@file 파일 이름을 구별할때.
@return 함수의 리턴값 나타낼때.
@author 작성자 이름을 나타낼때
@date 작성날짜를 나타낼때.
@param 함수 파라메터를 나타낼때
@see 참고할 함수나 페이지를 지정한다.
@todo 해야할일들에 대한 기술, 전체 항목의 @todo에 대한 리스트가 생성됩니다
@bug 버그에 대한 기술, 전체 항목의 @bug에 대해서 따로 리스트가 생성됩니다.
@code 중요 코드를 설명할때 시작 지점 가리킨다.
@endcode 중요 코드 설명할때 종료 지점 가리킨다.
@exeception exception처리에 대한 설명
@mainpage
@section
@throw: throw하는 객체나 변수등에 대한 설명
'Programming > 이것저것' 카테고리의 다른 글
| Doxgen 주석 (0) | 2011.05.02 |
|---|---|
| [펌] valgrind 를 이용한 메모리 관리 (0) | 2011.03.15 |
| _Crt Debug Functions (0) | 2010.07.23 |
| typeid 2 (1) | 2010.05.25 |
| 세그먼트 레지스터 (0) | 2010.05.01 |
