doxygen 예제

Javadoc과 마찬가지로 Doxygen는 소스 파일 주석에서 문서를 추출합니다. Doxygen는 Javadoc 구문 외에도 Qt 도구 키트에 사용되는 문서 태그를 지원하며 하이퍼텍스트 마크업 언어(HTML)와 Microsoft 컴파일HTML 도움말(CHM), 리치 텍스트 형식(RTF), 휴대용 문서 형식(PDF) 등의 출력을 생성할 수 있습니다. LaTeX, 포스트 스크립트 또는 맨 페이지. Doxygen 문서는 Mesos API 문서 파일을 생성하려는 인터페이스를 구성하는 소스 코드 파트에만 적용하면 됩니다. 이에 참여하지 않는 구현 코드는 소스 코드 주석에 의해 적절히 향상되어야 하지만 이러한 주석은 doxygen 스타일을 따르지 않아야 합니다. 메시지 시퀀스 차트에 대한 유효한 설명을 포함해야 하는 텍스트 조각을 시작합니다. 예제는 http://www.mcternan.me.uk/mscgen/ 참조하십시오. 텍스트 조각은 endmsc로 끝납니다. include 명령의 주요 목적은 여러 소스 및 헤더 파일로 구성된 예제 블록의 경우 코드 중복을 방지하는 것입니다. 예제에 대해 두 개 이상의 소스 파일이 필요한 경우 include 명령을 사용할 수 있습니다. 참고: Doxygen의 마크다운 파서의 단점으로 인해 현재 C++ 가 아닌 모든 코드 블록을 래핑하기 위해 들여쓰기를 사용합니다.

다음은 모든 요소를 함께 보여주는 짧은 예제입니다. 이것은 doxygen를 시연하기 위해 제시 된 Project 1 시작 코드의 이전 버전입니다 (즉, 이 코드를 잘라내고 현재 프로젝트에 붙여 넣기하지 마십시오!). 참고로, README.dox는 C 스타일 주석의 단일 블록이있는 텍스트 파일입니다. 어떤 언어가 의미되는지 문맥에서 명확하지 않은 경우(예: 주석이 .txt 또는 .markdown 파일에 있음) 일반적으로 언어와 연결된 doxygen를 곱슬 대괄호로 표시하여 언어를 명시적으로 나타낼 수도 있습니다. 코드 블록 후. 다음은 마지막 예제의 빈 줄을 참고하여 자세한 설명이 포함된 블록과 간단한 설명을 구분하는 데 필요합니다. 이 경우 JAVADOC_AUTOBRIEF도 NO로 설정해야 합니다. Doxygen에서 지원하는 프로그래밍 언어에는 C,[8] C++, C+, D, 포트란, IDL, Java, Objective-C,[9] 펄,[10] PHP,[11] 파이썬,[12][13] Tcl 및 VHDL이 포함됩니다.

[14] 다른 언어는 추가 코드로 지원될 수 있다. 현재 Doxygen 문서는 doxygen .를 사용하여 빌드 하위 디렉터리에서 빌드해야 합니다. /Doxyfile . 그러면 문서가 ./doxygen 하위 디렉터리로 생성됩니다. VHDL의 경우 주석은 일반적으로 « –« 로 시작합니다. Doxygen는 « –! »로 시작하는 주석을 추출합니다. VHDL에는 두 가지 유형의 주석 블록만 있습니다. 간단한 설명을 나타내는 한 줄의 « –! » 주석과 자세한 설명을 나타내는 다중 줄의 « –! » 주석(각 줄에 대해 « –! » 접두사가 반복되는 경우).

By | 2019-08-02T20:15:19+00:00 août 2nd, 2019|Non classé|Commentaires fermés sur doxygen 예제

About the Author: