매크로

매크로 변수를 사용하여 자신만의 간단한 QDoc 명령을 만들 수 있습니다.

매크로는 다음과 같은 경우에 유용합니다:

• 형식이 지정된 텍스트 스니펫과 같은 반복되는 텍스트를 문서에 포함할 때 유용합니다.
• 버전 문자열과 같은 정보를 빌드 시스템에서 .documentation으로 가져오기.
• 제품 이름과 같이 향후 변경될 가능성이 있는 문자열을 단일 위치에 유지 관리합니다.
• 용어나 제품 이름이 일관되게 사용되는지 확인합니다.
• 강제 줄 바꿈 및 특수 문자 등의 HTML 및 DocBook 요소를 사용하여 생성된 문서의 스타일을 지정합니다.
• 예를 들어 탭을 사용하여 다양한 프로그래밍 언어, 운영 체제 또는 도구에 대한 콘텐츠의 예를 표시합니다.

전역 매크로

모든 문서 프로젝트에서 사용할 수 있는 사전 정의된 전역 매크로 세트와 현재 값은 /qtbase/doc/global/macros.qdocconf 및 /qtbase/doc/global/htmltabs.qdocconf를 참조하세요. 여기에는 다음과 같은 매크로가 있습니다:

• 텍스트 스니펫 만들기
• HTML 및 DocBook 서식 지정
• 제품 이름
• 제품 버전
• 탭 콘텐츠
• YouTube 콘텐츠 링크
• 기타 매크로

Qt Online Installer 는 매크로 파일을 Qt 설치 폴더에 복사하므로 설치된 Qt에서 QDoc을 사용하여 문서를 작성하는 경우에도 매크로를 사용할 수 있습니다(소스에서 직접 QDoc을 작성하는 것과는 대조적으로).

매크로 추가하기

특정 문서 프로젝트에 대한 매크로를 프로젝트의 .qdocconf 파일 또는 프로젝트에 포함하는 .qdocconf 파일에 추가할 수 있습니다. 매크로가 두 개 이상의 문서 프로젝트에서 유용할 수 있는 경우 전역 매크로 파일에 추가하세요.

매크로 구문 및 옵션에 대한 자세한 내용은 매크로를 참조하세요.

매크로 사용

매크로는 기본 제공 QDoc 명령과 같은 방식으로 사용할 수 있습니다:

• 코드 소스 파일, 문서 댓글(.cpp, .qml)
• 문서 소스 파일(.qdoc, .qdocinc)

예를 들어

\QOI copies the macros files to your Qt installation folder.

사용되지 않는 매크로

글로벌 매크로 파일에는 이전 문서 세트와의 호환성을 위해 다음과 같은 더 이상 사용되지 않는 매크로가 포함되어 있습니다.