1. 주석

함수의 설명을 brief 태그를 이용하여 넣어본다.

/**
 * @brief       이것은 간단한 설명입니다.
*/
int Hello_World1(int a);

개발 도구(예: Visual Studio Code)에서 Hello_World1 함수에 대한 코멘트를 확인할 수 있다.

외부에서 해당 함수를 호출할 때도 확인할 수 있다.

함수의 인자값은 param 태그를 이용하여 코멘트를 넣을 수 있다.

/**
 * @brief       이것은 간단한 설명입니다.
 * @param a     이것은 인자 설명입니다.
*/
int Hello_World1(int a);

함수를 사용할 때 인자 값에 대한 코멘트를 확인해본다.

함수의 반환 값에 대한 설명을 작성해본다.

/**
 * @brief       이것은 간단한 설명입니다.
 * @param a     이것은 인자 설명입니다.
 * @return      이것은 반환 값 설명입니다.
*/
int Hello_World1(int a);

함수를 사용할 때 반환 값에 대한 코멘트를 확인해본다.

파일에 대한 설명을 최상단에 기재하여 적을 수 있다.

/**
 * 파일 제일 위에 파일에 대한 설명 등 정보를 넣는 것도 좋습니다.
 * @file   example.hpp
 * @author 2jinu
 * @date   2021-10-27
*/

/**
 * @brief       이것은 간단한 설명입니다.
 * @param a     이것은 인자 설명입니다.
 * @return      이것은 반환 값 설명입니다.
*/
int Hello_World1(int a);