doxygen 주석 예제
y posteado en Sin categoría

Doxygen는 `코드` 구문을 사용하여 무덤 악센트 기호 구문 마크업을 지원합니다. 예외 클래스는 @see 동일한 규칙을 사용하여 네임스페이스 자격을 갖춘 클래스여야 합니다. Doxygen는 하나 이상의 @throws 태그를 예외 및 설명 테이블로 렌더링하므로 @throws 설명의 첫 번째 단어로 취급하지 않습니다. 다음은 구조적 명령을 사용하여 문서화된 structcmd.h라는 C 헤더의 예입니다: Doxygen의 첫 번째 버전은 베를린 주세 연구소에서 롤랜드 원더링과 말트 외클러가 개발한 DOC++의 초기 버전에서 코드를 빌렸습니다. 나중에, Doxygen 코드는 디미트리 반 Heesch에 의해 다시 작성되었습니다. 예를 들어 설명서에 다음 명령을 넣는 것은 EXAMPLE_PATH에서 가리켜야 하는 하위 디렉터리에 있는 파일 예제.cpp의 스니펫을 참조합니다. 첫 번째 문장 다음의 문장은 첫 번째 문장에서 사용되는 용어를 정의하고, 더 미세한 동작을 명확히 하고, 예제 사용법, 수학적 배경 또는 필요하다고 판단되는 다른 모든 것을 제공하는 데 사용할 수 있습니다. 이 페이지에서는 Doxygen를 사용한 공용 코드 설명서에 중점을 두고 내부 주석은 DM C++ 스타일 가이드에서 설명합니다. 또는 이 예제에서 와 같이 C 스타일 주석 블록을 연 후 Qt 스타일을 사용하고 느낌표(!)를 추가할 수 있습니다.

LSST 스택은 Doxygen를 사용하여 주석 블록에서 C++ API 참조 설명서를 작성합니다. 이 설명서는 코드를 읽는 개발자부터 스택 Doxygen 설명서의 독자에 이르기까지 다양한 컨텍스트에서 사용자에게 노출됩니다. 위의 예제의 각 주석 블록에는 구조 명령이 포함되어 있으므로 생성된 문서에 영향을 주지 않고 모든 주석 블록을 다른 위치 또는 입력 파일(예: 소스 파일)으로 이동할 수 있습니다. 이 방법의 단점은 프로토타입이 중복되므로 모든 변경 사항을 두 번 해야 한다는 것입니다! 이 때문에 이것이 실제로 필요한지 먼저 고려하고 가능하면 구조 명령을 피해야 합니다. 함수 앞에 배치되는 주석 블록에 fn 명령이 포함된 예제를 자주 받습니다. 이것은 분명히 fn 명령이 중복되어 문제만 발생할 수 있는 경우입니다. 주석 블록에 소스 코드 예제에 대한 설명서가 포함되어 있음을 나타냅니다. 원본 파일의 이름이 . 이 파일의 내용은 주석 블록에 포함된 설명서 바로 직후 설명서에 포함됩니다. 원하는 경우 예제에 대한 줄 번호를 활성화하기 위해 {lineno} 옵션을 추가할 수 있습니다. 모든 예제는 목록에 배치됩니다.

소스 코드는 문서화된 멤버 및 클래스에 대해 검색됩니다. 발견되면 이름은 설명서와 상호 참조됩니다. 원본 파일 또는 디렉토리는 doxygen 구성 파일의 EXAMPLE_PATH 태그를 사용하여 지정할 수 있습니다. mscgen에서 생성된 이미지를 설명서에 삽입합니다. 예제는 http://www.mcternan.me.uk/mscgen/ 참조하십시오. 파일 이름 다음의 텍스트는 코드 조각의 고유 식별자입니다. 이는 위의 snippet 명령에 해당하는 다음 예제와 같이 관련 스니펫 파일에서 인용된 코드를 구분하는 데 사용됩니다. 하기, 자세한 설명을 포함하는 블록으로부터 간략한 설명을 분리하는 데 필요하다.

Compartir este contenido...
Tweet about this on TwitterShare on FacebookShare on Google+Email this to someone
Los Comentarios están cerrados.