ABOUT ME

-

Today
-
Yesterday
-
Total
-
  • 소스 문서화 툴 Doxygen의 주석문 명령어 정리
    개발/지름 2008. 1. 24. 15:46
    반응형

    *Doxygen 기본 스타일
       /** */

    *주석안에 아이템들
     @breif ==> 설명을 쓴다. 여러줄을 쓸때에는 @breif를 쓰고 한줄 띄운다움 계속해서
                   쓰면된다.
     @file ==> 파일 이름을 구별할때.
     @return ==> 함수의 리턴값 나타낼때.
     @author ==> 작성자 이름을 나타낼때
     @date ==> 작성날짜를 나타낼때.
     @param ==> 함수 파라메터를 나타낼때
     @see ==> 참고할 함수나 페이지를 지정한다.
     @todo
     @bug
     @code ==>중요 코드를 설명할때 시작 지점 가리킨다.
     @endcode ==> 중요코드 설명할때 종료 지점 가리킨다.
     @exeception
     @mainpage
     @section
     
     ====클래스 처리===
     @class ==> 클래스명 나타낼때.
     *클래스 멤버에대한 처리
     /// 이렇게 표시한다.(단 멤버 상단에 표시할것!!)
     /**< 내용 */ 이렇게도 표시한다. (멤버 옆에)
     ///< 이렇게도 표시한다.(멤버옆에)
     
     ====enum 타입처리====
    *상단에 @brief로 무엇을 하는것인지 나타내고
     각각의 멤버에 대해서는.
     /*!< 내용 */  이렇게 표시한다. (멤버 옆에)
     /**< 내용 */ 이렇게도 표시한다. (멤버 옆에)
     ///< 이렇게도 표시한다.(멤버옆에)

    ===중요 코드도 주석을 단다.===
    @code 로 시작해서
    @endcode 로 끝낸다.

     예제)
         /**
          * @brief 예제코드
          *
          *  추가설명
          * @code
            *........
            * @endcode
          */

    반응형

    댓글

Designed by Tistory.