[C언어][초급] Chapter06. 주석 작성 방법과 코드 스타일 – 읽기 쉬운 코드의 첫걸음

코드는 사람도 읽습니다
프로그래밍을 하다 보면 이런 말을 듣게 됩니다.

"코드는 컴퓨터에게 실행되기 위해서가 아니라, 사람에게 이해되기 위해 작성해야 한다."

 

C언어도 마찬가지입니다.
내가 작성한 코드를 나중에 다시 보기 위해서, 또는 다른 사람과 함께 협업하기 위해서는 코드 자체만큼이나 주석과 스타일이 중요합니다. 이번 글에서는 C언어에서 주석을 작성하는 방법과 보기 좋은 코드 스타일을 정리해보겠습니다.

---

● 주석(comment)이란?

주석은 코드에 영향을 주지 않지만, 사람에게 설명을 전달하는 문장입니다.
컴파일러는 주석을 무시하기 때문에, 프로그램 실행에는 전혀 영향을 미치지 않습니다.
주석은 다음과 같은 용도로 사용됩니다:

• 코드의 목적 설명
• 변수, 함수의 의미 설명
• 복잡한 알고리즘의 흐름 기록
• TODO 목록 작성 (추후 수정 예정 항목 등)

---

● 주석의 종류

C언어에서 사용할 수 있는 주석 방식은 두 가지입니다.

1. 한 줄 주석

// 이 줄 전체가 주석입니다.
int a = 10; // 변수 a를 10으로 초기화

• // 뒤의 내용은 컴파일되지 않습니다.
• 코드 옆이나 위에 간단한 설명을 붙이기 좋습니다.

2. 여러 줄 주석

/*
여러 줄에 걸쳐 주석을 작성할 수 있습니다.
설명이 길거나 블록 단위로 주석을 달고 싶을 때 유용합니다.
*/
int b = 20;

• /*와 */ 사이에 있는 내용은 모두 주석 처리됩니다.
• 중첩 사용은 허용되지 않으므로 주의가 필요합니다.

---

● 실습 예제: 주석 달기

아래의 예제를 참고해 직접 주석을 달아보세요:

#include <stdio.h>

int main(void) {
    int x = 5;      // 정수형 변수 x를 선언하고 5로 초기화
    int y = 3;      // 정수형 변수 y를 선언하고 3으로 초기화

    int result;     // 연산 결과를 저장할 변수

    // x와 y를 더한 값을 result에 저장
    result = x + y;

    // 결과 출력
    printf("x + y = %d\n", result);

    return 0;       // 프로그램 정상 종료
}

[연습]

• 각 변수의 의미, 계산 과정, 출력 내용 등을 직접 주석으로 정리해보세요.
• 코드의 맨 위에 "프로그램 목적"을 한 줄 주석으로 적는 연습도 해보면 좋습니다.

---

 

● 코드 스타일: 읽기 쉬운 코드 만들기

좋은 코드는 기능만 잘 동작하는 것이 아니라 읽기 쉽고 이해하기 쉬운 구조를 가져야 합니다. 다음은 기본적인 스타일 가이드입니다:

1. 들여쓰기(Indentation)

int main(void) {
    int a = 1;
    if (a > 0) {
        printf("양수입니다.\n");
    }
}

• 들여쓰기를 하면 코드 구조가 한눈에 들어옵니다.
• 보통 스페이스 4칸 또는 탭 1칸을 사용합니다. 일관성 있게 유지하는 것이 중요합니다.

2. 괄호 위치 통일

// 일반적인 스타일
if (a > 0) {
    printf("positive\n");
}

• 여는 중괄호 {는 같은 줄에 쓰거나 다음 줄에 쓰는 스타일이 있지만, 하나로 통일하는 것이 좋습니다.

3. 공백 활용

int sum = a + b;

• 연산자 사이에 공백을 넣으면 더 보기 좋습니다.
• 너무 빽빽한 코드는 읽기 어렵습니다.

4. 의미 있는 변수명 사용

int score = 95;
int age = 20;

• a, b보다 score, age처럼 의미가 있는 이름이 더 좋습니다.

5. 함수 단위 구분

void printResult(int result) {
    printf("결과: %d\n", result);
}

• 기능이 분리되는 부분은 함수로 작성하고, 주석을 통해 역할을 명시해두는 것이 좋습니다.

---

● 정리하며

주석은 단순한 설명이 아니라, 코드의 일부분입니다.

앞으로 프로젝트가 복잡해질수록 주석의 중요성은 더욱 커집니다.
그리고 코드 스타일은 단순히 보기 좋게 만드는 것이 아니라, 협업과 유지보수를 위한 최소한의 예의이기도 합니다.

 

지금부터라도 주석을 습관처럼 달고, 읽기 쉬운 코드를 작성하려는 연습을 시작해보세요.
처음부터 좋은 습관을 들이는 것이, 앞으로의 실력을 크게 바꿔줄 것입니다.