Doxgen 주석

[참조: http://idrose1025.egloos.com/2628732]
[그림 참조: http://alghost.tistory.com/22]

Doxygen 주석 사용법 

Doxgen은 많이 사용하고 있고 사용법도 간단하지만 가끔 어떤 식으로 주석을 해야하는지 까먹습니다. 
아래와 같은 형식이 가장 마음에 들고 좋은 것 같습니다.

\brief 나 \return 등이 보여주는 항목 이외에 다른 항목을 쓰고 싶다면 \par 명령어를 사용하면 된다.

/** \brief

        현재 시간을 얻는다.

    \remarks

        ST_TIME 구조체 형식으로 현재 시간을 얻는다.

    \par 요구사항

        time.h 선언이 필요하다.

    \return

        성공시 0을 반환한다. 에러가 발생하면 -1을 반환한다.

    \author

        이상호

**/

Blogger: moltak.net