Doxygen의 함수 내부에서 주석을 추출 할 수있는 방법은 무엇입니까?

StackOverflow https://stackoverflow.com/questions/758045

문제

Doxygen이 생성 된 HTML 파일에 넣을 수있는 방식으로 함수 (C, C ++, Java)에 의견이있을 수 있는지 알고 싶습니다.

예를 들어:

function(...)
{
do_1();
/**
 * Call do_2 function for doing specific stuff.
 */ 
do_2();
}
도움이 되었습니까?

해결책

아니요, Doxygen은 기능 본체 내부의 주석 블록을 지원하지 않습니다. 매뉴얼에서 :

Doxygen을 사용하면 문서 블록을 실제로 어디에나 넣을 수 있습니다 (예외는 기능 본문 또는 일반 C 스타일 주석 블록 내부에 있습니다).

부분: 코드를 문서화하는 독시원

다른 팁

나는 C를 알지 못하지만 객관적인 C에서 매일 다음과 같은 의견이 있습니다.

/// This method perform the following operations:
- (void) myMethodWith: (id) anObjectArgument
{
    /// - do op1
    [self op1];

    /// - do op2
    op2(anObjectArgument);
}

다음과 같이 렌더링됩니다.

이 방법은 다음 작업을 수행합니다.

  • OP1을 수행하십시오

  • OP2를 수행하십시오

편집하다: Dana the Sane의 의견에 따라 Doxygen 문서에 대한 나의 이해와 그것이 내 경험과 모순되지 않는 이유.

내가 doxygen 문서를 이해하고 해석하는 한, 이것은 Aaron Saarela가 제공 한 견적. 그가 제공하는 링크가 시작될 때, 신체 내 문서에 관한 단락이 있습니다.

각 코드 항목에 대해 문서를 형성하는 두 가지 (또는 경우에 따라 3 가지) 설명이 있습니다. 간단한 설명과 자세한 설명은 모두 선택 사항입니다. 방법과 함수의 경우, 세 번째 유형의 설명, 소위 "신체"설명이 있으며, 이는 방법이나 기능의 본문 내에서 발견 된 모든 주석 블록의 연결로 구성됩니다.

이것은 기능이나 방법 본문에 독소 문서를 넣어도 괜찮다는 것을 의미합니다. 이것이 제가 내 대답 위에 묘사 한 것입니다.

제 생각에 Aaron이 인용 한 단락은 일반적으로 기능 또는 메소드 선언 또는 구현 이론 앞에 놓인 문서를 나타냅니다. 이것은 매개 변수, 반환 값 등을 설명하는 것입니다. 저것 표제 기능이나 방법의 본문 안에 문서를 넣을 수 없습니다.

그러나 신체 내부 알고리즘의 각 단계에 관한 자세한 문서는 Doxygen에 의해 완벽하게 처리됩니다.

코드 내부의 의견은 사용자가 읽을 수있는 기능의 기능이 아니라 다른 프로그래머가 이해할 수있는 특정 구현 스 니펫을 설명하기위한 것입니다.

사용자를 위해 문서화 해야하는 경우 수행해야합니다. ouside 함수 블록은 인터페이스를 정의하는 주석 (서명 및 전제 조건, 사후 조건, 사용 예제 또는 필요한 것으로 간주)에 있습니다.

대신 기능 코드를 예제로 넣을 수도 있습니다.http://www.doxygen.nl/manual/commands.html#cmdexample

라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top