Doxygen 주석 작성을 위한 빠른보기
2007/08/09 11:31

MainPage

생성된 doc의 처음 화면이다.
보통 프로젝트 첫 화면이므로 전체 프로젝트에 한군데만 써 넣는다.

/// @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"에 "!"추가

파일

파일에 대한 설명이므로 파일의 맨처음 부분에 넣는다.

/// @file     doxygentest.c
/// @brief    doxygentest  소스파일.

함수

함수의 기능과 리턴값을 설명하도록 한다.
보통 간단하게 아래와 같이 작성한다.

/// @brief string의 조사하여 babo라는 문구가 있는 찾는 함수
/// @param char* str char*형의 string을 입력한다.
/// @return boolean의 성공여부 , true이면 성공

필요에 따라 다음의 기능도 있다.

@author: 작성자 표시를 합니다.
@date: 작성일등의 날짜 표시를 합니다. 직접 기술 해야 합니다.
@see: 참고하는 함수/클래스등의 표시로 해당 항목(doxygen에서 존재하는)의 링크를 제공합니다.
@return: 함수의 리턴값에 대한 설명
@exception: exception처리에 대한 설명
@throw: throw하는 객체나 변수등에 대한 설명
@version; 버전설명
@warning: 경고
@bug: 버그에 대한 기술, 전체 항목의 @bug에 대해서 따로 리스트가 생성됩니다.
@todo: 해야할일들에 대한 기술, 전체 항목의 @todo에 대한 리스트가 생성됩니다.
@param: 함수의 파라미터 대한 정보를 기술 합니다.

파라미터에 대한 설명은 아래와 같이 입력할수도 있다.

int main( int    argc,          ///< 인자개수
            char * argv[] )    ///< 인자

Class, 구조체, 변수

가급적 class, 구조체, 변수(global변수)의 상단에 설명을 작성한다.
/// 무엇을 하는 class, 구조체, 변수이다.

class와 구조체는 아래와 같이도 작성할수 있다.
/// @class 클래스 설명
/// @struct
/// 구조체 설명

@brief 를 사용하여 설명을 작성할수도 있다.
변수명의 경우 상단에 작성을 하지않고 변수명과 같은라인에서 작성하고 ///< 로도 설명을 작성할수 있다.
int a; ///< 임의의 값

단 함수내부에 있는 변수들에 대한 설명은 작성할수 없다.

태그사용

목록을 위한 점 표시
/// - 원하는 내용

강조를 위한 굵은글씨
/// <b> 원하는 내용</b>

원하는 내용, 코드를 그대로 출력
/// <pre>
/// 원하는 내용
/// </pre>

Link

KLDP의 doxygen 강좌 - 설치,사용
http://wiki.kldp.org/wiki.php/Doxygen

Doxygen wiki - 그래프 및 스타일시트 변경
http://www.pie.pe.kr/cgi-bin/moin.cgi/Doxygen

Doxygen 문법 및 option 설정
http://wiki.rabidus.net/ow.asp?Doxygen

Doxygend의 Link 페이지 정리
http://cse.kangnam.ac.kr/board/content.asp?idx=6291&GotoPage=5&table=bbs_free

Doxygen 홈페이지
http://www.doxygen.org/

이 글은 스프링노트에서 작성되었습니다.

2007/08/09 11:31 2007/08/09 11:31
TAG
Trackback Address :: 이 글에는 트랙백을 보낼 수 없습니다

  • Woof 2007/08/09 11:55  댓글주소  수정/삭제  댓글쓰기
    요즘 많이 바쁘신가봐요. :)
  • ㅋㅋㅋ 2007/08/22 14:45  댓글주소  수정/삭제  댓글쓰기
    정리 대 마왕이네용잉.... 존경스럽네용