< 클래스 주석 예시 >
/**
* @brief 클래스 간략 설명
* @details 클래스 자세히 설명
* @author
* @date
* @version
*
*/
< 메서드 주석 예시 >
/**
*@brief 메서드 간략 설명
*@details 메서드 자세히 설명
*@param args 콘솔 파라미터
*@return 프로그램상태
*@bug 메모리 누수 있음.
*@todo 버그 해결해야함
*/
@Item 이란?
@mainpage 프로그램의 전체 개요 설명
@section 프로그ㅐㄻ의 개요 별로 설명
@version 프로그램 버전을 설명합니다.
@breif 간략한 설명을 쓸 때 사용합니다.
@details 자세한 설명을 쓸 때 사용합니다.
@file 파일 이름 구별
@author 작성자 이름
@date 작성 날짜
@param 함수의 파라미터 설명
@return 함수의 리턴값 설명
@exception 예외 처리를 설명합니다.
@see 참고할 함수나 페이지 지정
@todo 해야할 일에 대해서 따로 리스트를 정리합니다.
@bug 버그에 대해서 따로 리스트를 생성합니다.
참고 주소
https://www.slideshare.net/arload/doxygen-33932243
반응형
댓글