Doxygen/강좌02
차례 ¶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; } 2.1. Doxygen 주석의 시작과 끝 ¶일반적으로 Doxygen은 주석을 가지고 문서화를 한다.
그러므로 일반주석과 Doxygen주석을 구분해야 하는데 이것때문에 C언어에서는 /* */ : 일반주석 /** */ : Doxygen주석 이렇게 쓰이고 있다. 그러므로 Doxygen문서화를 하기위해서는 /** */ 안에 주석을 달아야한다. 물론 C 어 일반주석은 Doxygen에서 무시된다. 2.2. File ¶파일을 설명하기 위한 Doxygen 주석이다.
hello.c 에서는 아래의 것들만 쓰였는데 그외 여러가지가 있다.
/**
@file hello.c @brief hello world 소스파일. */ |
Your own qualities will help prevent your advancement in the world.    
|
