C# 강의 - 05 주석
주석은 함께 프로그램을 개발하는 동료와 미래의 나에게 주는 조언입니다.
2021-01-26

장기나 체스 게임을 할 때 어떤 고수가 나에게 은밀히 팁을 준다면 게임에 큰 도움이 되겠죠? 프로그래밍에서의 주석도 비슷한 역할을 합니다. 주석은 개발자에게 특정 코드의 의미가 무엇인지, 어떻게 동작할 것인지 등의 정보를 기록하는 것입니다. 주석은 개발자를 돕기 위한 기능이기 때문에 프로그램의 작동에는 영향을 미치지 않습니다.

주석은 적절한 위치에, 직관적인 내용으로 기록하는 것이 필요합니다. 하지만 그것보다 더 중요한건, 처음부터 누구나 기능을 쉽게 예측할 수 있도록 코드를 작성하는 것입니다.




주석은 다음의 코드처럼 작성할 수 있습니다.
// 기호는 한 줄의 주석만 작성할 수 있습니다.

int a = 42; // 나이
Console.WriteLine(a);


그리고 다음의 코드처럼 작성할 수도 있습니다.
/**/ 기호는 한 줄 이상의 주석을 작성할 수 있습니다.

/* 아래 변수는 나이를 가리킵니다.
   하지만 나이는 숫자에 불과해요. */
int a = 42;
Console.WriteLine(a);


하지만 위 코드를 아래와 같이 작성한다면, 굳이 주석을 사용하지 않더라도 변수 이름을 통해 나이라는 것을 유추할 수 있게 됩니다. 따라서 아래 코드가 더 간단하고, 직관적인 코드라고 할 수 있겠습니다.

int age = 42;
Console.WriteLine(age);