Doxygen 개요

Doxygen은 문서 생성기이자 소프트웨어 참조 설명문을 작성하기 위한 도구이다.

그렇기에 C/C++,C#등 소스 주석을 읽어서 HTML/PDF등으로 생성해준다.

 

이는 주석만 잘써도 자동으로 문서를 생성해주고, 문서 품질을 지속 관리 시킬수있는 장점이있다.

 

문법 및 사용법을 보면 다음과 같다.

 

일반 문법은 '/*'를 사용하는 것이다

/**
내용
*/

예를 들면 이런 형식이다.

또는 

/**
 * 내용
 * 내용
 ...
 */

이렇게도 된다.

 

물론 단일 라인 주석도 지원한다.

/// 내용
/// 내용
/// 내용

블록을 보면 /*, /**,  /*!. ///, //! 등 여러 블록을 지원하고

 

태그는 여러개가 있는데 자주쓰는 태그를 정리하면 다음과 같다.

@brief //함수/클래스/파일의 짧은 요약 설명

@param //함수 인자 설명

@return //함수의 반환값 설명

@note //참고 사항, 부가 설명

@file //파일 설명

@warning //주의 사항 강조

@page //개별 문서 페이지 생성

 

이를 바탕으로 예시 코드를 쓰면 다음과 같다

 

/**
 * @file motor_ctrl.c
 * @brief 메인 로직
 */

/// 모터 상태
typedef M_num {
  MOTOR_STOP = 0,  ///< 정지
  MOTOR_RUN       ///< 회전
} MotorState;

/**
 * @brief 목표 RPM으로 모터를 구동
 * @param target_rpm 목표 회전수(RPM)
 * @return 0: 성공, 음수: 에러 코드
 * @note 내부적으로 PID를 사용
 * @see MotorState
 */
int Motor_Run(int target_rpm);

 

문서를 쉽게 작성하기 좋을뿐만 아니라 Grahpviz를 이용하여 함수 호출자 그래프, 클래스 다이어그램등을 생성하여 더 보기 쉽게 만들수도 있다.

 

또한 Doxygen은 GPLv2로 배포는 자유 소프트웨어이기 때문에 Git저장소 또는 홈페이지에 가면 Window, Linux, Mac등 설치 할수있다.