doxygen 주석 예제

@overload 태그에 의해 생성된 텍스트는 독자에게 “위” 메서드를 보도록 지시합니다. Doxygen는 네임스페이스 및 클래스 멤버에 대한 자세한 설명서를 정렬하므로 생성된 설명서를 확인하여 @overload 태그를 사용하기 전에 완전히 문서화된 오버로드가 나타나는지 확인해야 합니다. 기본적으로 Doxygen는 매우 긴 경우상수값을 표시합니다. @showinitializer 및 @hideinitializer 태그는 이 동작을 재정의합니다. 예제 디렉터리에서 파일 manual.c에서는 이 명령을 사용하는 방법을 보여 주십습니다. 다음은 Qt 스타일을 사용하는 문서화된 C++ 코드의 예입니다: LSST는 마크다운 형식의 Doxygen 주석 블록을 사용합니다. 마크다운을 사용하여 특정 형식을 표현할 수 없는 경우 Doxygen의 기본 제공 서식또는 필요한 경우 HTML 태그를 사용할 수 있습니다. 세 번째 대안은 각 줄이 추가 슬래시 또는 느낌표로 시작하는 두 개 이상의 C++ 주석 줄 블록을 사용하는 것입니다. 다음은 두 가지 사례의 예입니다. 이것은 doxygen를 시연하기 위해 제시 된 Project 1 시작 코드의 이전 버전입니다 (즉, 이 코드를 잘라내고 현재 프로젝트에 붙여 넣기하지 마십시오!). 참고로, README.dox는 C 스타일 주석의 단일 블록이있는 텍스트 파일입니다. 특정 방법, 자습서 및 예제는 메모 대신 예제 섹션으로 이동합니다. 메모 섹션은 개념 문서 전용입니다.

세 번째 옵션은 두 줄 이상에 걸쳐 있지 않은 특수 C++ 스타일 주석을 사용하는 것입니다. 다음은 두 가지 예입니다: Doxygen를 사용하면 문서 블록을 거의 어디서나 넣을 수 있습니다(예외는 함수 본문 내부 또는 일반 C 스타일 주석 블록 내부에 있음). 인접한 여러 param 명령이 단일 단락에 결합됩니다. 각 매개 변수 설명은 새 줄에서 시작됩니다. param 설명은 빈 줄이나 다른 단면 명령이 발생하면 종료됩니다. 예제는 fn 섹션을 참조하십시오. 다음은 문서의 모양을 예로 들 수 있으므로 스타일에 대한 구체적인 권장 사항을 만들 수 있습니다 (모두 Javadoc 및 아마도 doxygen에 대한 표준입니다): 예제는 C 파일을 문서화하는 데 중점을 두고 있습니다. 현재 개발 중인 Box 컴파일러의 헤더 프로토타입으로 사용합니다. internal 명령이 섹션 내에 배치되면(예: 섹션 참조) 명령 이후의 모든 하위 섹션도 내부로 간주됩니다. 동일한 수준의 새 섹션만 내부로 간주되는 조각을 종료합니다. 파일 doxygen_c.h는 아래와 같습니다.

Doxygen로 처리되면이 출력을 제공합니다. VHDL의 경우 주석은 일반적으로 “–“로 시작합니다. Doxygen는 “–!”로 시작하는 주석을 추출합니다. VHDL에는 두 가지 유형의 주석 블록만 있습니다. 간단한 설명을 나타내는 한 줄의 “–!” 주석과 자세한 설명을 나타내는 다중 줄의 “–!” 주석(각 줄에 대해 “–!” 접두사가 반복되는 경우). 구조 명령(다른 모든 명령과 마찬가지로)은 Javadoc 스타일을 선호하는 경우 백슬래시() 또는 at-sign(@)으로 시작하고 명령 이름과 하나 이상의 매개 변수가 뒤따릅니다. 예를 들어 위의 예제에서 클래스 Test를 문서화하려는 경우 doxygen에서 읽는 입력의 어딘가에 다음 설명서 블록을 넣을 수도 있습니다. 그것은 서식일반 텍스트 메일에서 영감을. 마크다운은 프로젝트의 소개 페이지와 같이 단순하고 일반적인 서식에 적합합니다. Doxygen는 마크다운 파일 의 판독도 직접 지원합니다. 자세한 내용은 마크다운 지원 장을 참조하십시오. Doxygen에는 C++ 클래스에 대한 상속 다이어그램을 생성하는 기본 제공 지원이 있습니다.

고급 다이어그램과 그래프의 경우 Doxygen는 Graphviz의 “점” 도구를 사용할 수 있습니다. [15] 일반적으로 문서 블록은 원본(.cc) 파일이 아닌 헤더(.h) 파일에 나타납니다.