Private Quick
Directory
생성된 doc의 처음 화면이다. 보통 프로젝트 첫 화면이므로 전체 프로젝트에 한군데만 써 넣는다.
/** * @mainpage VIHub (VISSIM - IRIS) * @section intro Introduction * This program is being developed in NATSRL to simulate traffic algorithm with VISSIM and IRIS. * @section CREATEINFO Developer Information * Chongmyung Park (auau44@gmail.com) \n * @section MODIFYINFO Progress * Chongmyung Park / 03.02.2010 : writing this page */
파일에 대한 설명이므로 파일의 맨처음 부분에 넣는다.
/** * @file Communicator.java * @brief Thread Class corresponding each client. This class receive request from client and then match to protocol (eg. MnDot) */
함수 함수의 기능과 리턴값을 설명하도록 한다. 보통 간단하게 아래와 같이 작성한다. <code>
/* * @brief string의 조사하여 babo라는 문구가 있는 찾는 함수 * @param char* str char*형의 string을 입력한다. * @return boolean의 성공여부 , true이면 성공 */
필요에 따라 다음의 기능도 있다.
가급적 class, 구조체, 변수(global변수)의 상단에 설명을 작성한다.
/ 무엇을 하는 class, 구조체, 변수이다. class와 구조체는 아래와 같이도 작성할수 있다. / @class 클래스 설명 / @struct / 구조체 설명
@brief 를 사용하여 설명을 작성할수도 있다. 변수명의 경우 상단에 작성을 하지않고 변수명과 같은라인에서 작성하고 /< 로도 설명을 작성할수 있다 int a; /< 임의의 값
단 함수내부에 있는 변수들에 대한 설명은 작성할수 없다.
Discussion