Doxygen 및 코드 문서 - 기능

문서 미리보기

Quick Documentation(빠른 문서) 팝업(Ctrl+Q)에서 Doxygen 문서 미리보기를 확인해 보세요). Doxygen 명령어가 분석되어, 유형 정보와 함께 보기 좋게 배치되어 있습니다.

함수 매개변수와 함수 설명이 서로 다른 문서에 정리되어 있는 경우, CLion은 모든 주석을 병합하여 전체 함수의 시그니처를 포함한 문서를 표시합니다(Doxygen에서 출력을 생성할 때의 방식과 같음).

안전하게 이름 변경

문서를 올바르게 유지하려면 Rename(이름 변경) 리팩터링(Shift+F6)을 사용하여 함수 이름이나 매개변수를 업데이트하세요. 그러면 CLion에서 Doxygen 주석 및 기타 참조 내용을 동시에 업데이트합니다.

완성 기능 사용

빠른 코드 입력을 위해 Clion은 Doxygen 명령 및 함수 매개변수에 자동 완성 기능을 제공합니다.

문서 생성

함수에 새로운 Doxygen 주석을 추가하려면 간단히 생성하기만 하면 됩니다. /**, /*!, /// 또는 //!를 입력한 다음 Enter를 누르세요. 함수가 매개변수를 가지고 있거나 값을 반환하거나 예외를 던지는 경우 스텁이 생성됩니다.

빠른 문서

Quick Documentation(빠른 문서) 팝업(Ctrl+Q)은 캐럿 위치의 코드 요소에 대한 추가 정보를 제공하는 범용 도구입니다. 기본적으로 CLion에서 마우스를 올리면 빠른 문서가 자동으로 표시됩니다. 호출하는 요소에 따라 팝업에 다음과 같은 정보가 표시됩니다.

함수 시그니처 세부 정보.
코드 문서(일반 또는 Doxygen 주석).
추론된 타입. 명시적 타입이 부족할 수 있는 최신 C++에서 특히 유용.
타입 크기.
중첩된 매크로를 더욱 잘 이해하고 디버그하는 데 도움이 되는 매크로 치환.
상수 표현식의 값.
정수로 표시된 Enum 값.