✅ 목표 (Goal)

C언어의 주석을 작성하는 문법에 대해서 알아보자.

✅ 주석 문법

C언어에서 주석 문법이 어떻게 되는지 모르는 사람은 없을것이다.

문법이 너무 간단해서, 뭐 설명이 필요없다.

/*
여러줄을 주석처리 하려면
이렇게 묶으면 되지요.
*/

// 한줄만 주석처리 하고 싶을때는 슬래쉬(/)를 2개 쓰면 된다.

✅ 샘플

/*와 //를 어떻게 쓰는지 구경해보자.

/*
player a와 b의 rank를 비교하여 오름차순으로 정렬하는 함수입니다.
*/
void compare_rank_by_asc(player_t* a, player_t* b) {
    if (a->rank > b->rank) {
        return 1;
    }
    else return -1;
}

//player a와 b의 rank를 비교하여 내림차순으로 정렬하는 함수입니다.
void compare_rank_by_desc(player_t* a, player_t* b) {
    if (a->rank < b->rank) { // > 만 <로 바꿔요
        return 1;
    }
    else return -1;
}

✅ 좋은 주석이란?

후술하겠지만, 위와 같은 주석은 그다지 좋은 주석이 아니다.