KLDPWiki: Doxygen/강좌02

Doxygen/강좌02

[edit]

차례 ¶

1. 차례

2. hello.c 분석

2.1. Doxygen 주석의 시작과 끝

2.2. File

2.2.1. @file
2.2.2. @brief

2.3. 함수 정의

2.3.1. @brief
2.3.2. @return
2.3.3. /**<

3. 맺음말

4. 댓글

[edit]

2. hello.c 분석 ¶

    /**
      @file     hello.c
      @brief    hello world  소스파일.
     */
    #include <stdio.h>

    /**
      @brief    hello Main 함수.
      @return   성공여부.
     */
    int main(
        int    argc,       /**< 인자개수 */
        char * argv[]      /**< 인자 */
        )
    {
        printf("Hello World\n");
        return 0;
    }

[edit]

2.1. Doxygen 주석의 시작과 끝 ¶

일반적으로 Doxygen은 주석을 가지고 문서화를 한다.

그러므로 일반주석과 Doxygen주석을 구분해야 하는데

이것때문에 C언어에서는

  /* */       : 일반주석
  /** */      : Doxygen주석

이렇게 쓰이고 있다.

그러므로 Doxygen문서화를 하기위해서는 /** */ 안에 주석을 달아야한다.

물론 C 어 일반주석은 Doxygen에서 무시된다.

[edit]

2.2. File ¶

파일을 설명하기 위한 Doxygen 주석이다.

hello.c 에서는 아래의 것들만 쓰였는데 그외 여러가지가 있다.

   /**
     @file     hello.c
     @brief    hello world  소스파일.
    */

[edit]

2.2.1. @file ¶

   @file    파일명

은 Doxygen문서화를 할때 이파일을 추가 시켜라는 지시자이다.

[edit]

2.2.2. @brief ¶

     @brief    hello world  소스파일.

brief를 영어로 해석하면 간단한 설명이다.

말 그대로이다. hello.c 파일의 간단한 설명이다.

[edit]

2.3. 함수 정의 ¶

함수를 문서화 하기위한 문법이며 함수 바로 위에 Doxygen주석을 쓴다.

    /**
      @brief    hello Main 함수.
      @return   성공여부.
     */
    int main(
        int    argc,       /**< 인자개수 */
        char * argv[]      /**< 인자 */
        )