[이렇게쓰더라고] Doxygen C/C++ 주석

코드를 보다보니 Doxygen을 통해 접하게되는 것들이 있는데, 아직도 인텔리제이가 익숙한 것일까 한번 더 볼겸 정리해봤다. ctrl 누른 상태로 클릭시 코드 넘어가지는 것이 안되는게 VScode 너무 불편하다.

 

---

🔔우선 Doxygen이 무엇일까?

도큐멘테이션 생성기이자 소프트웨어 참조 설명문을 작성하기 위한 도구이다.

설명문은 코드 내에 작성되므로 상대적으로 최신화 상태를 유지하기가 용이한 편이다.

Doxygen은 설명문과 코드를 상호 참조할 수 있으며 문서의 독자는 쉽게 실제 코드를 참조할 수 있다.

 

 

주석 항목은 @을 통해 명시할 수 있다.

@author 작성자 이름

@brief 간략한 설명 기재

@bug 버그

@code 중요 코드 설명 시 시작 지점 설정

@date 작성날짜 

@endcode 중요 코드 종료 지점 설정

@exception 예외처리

@file 파일명 구별

@fn 함수명 구별

@mainpage 메인페이지 설명

@param 함수 파라미터 표시

@remark 자세한 설명 및 주의 사항에 관해 기재

@return 함수 리턴 값을 나타낼 때

@section

@see 참고할 함수나 페이지 설명

@struct 구조체 정의

@todo 다음에 작업할 내용 기재

@version 버전