1편에서 다음에 다루기로 약속한 부분은 다음 기회에..

잘 자다가 밖이 너무 시끄러워서 깼다



난 뭔가 널리 알려진 사실보다는 어떤 문제에 대한 다른 시각에 대해서 글을 쓰는게 더 재밌다.

게임프로그래밍이라기 보다는 일반적인 내용이라 미안..

아무튼 이번에는 주석의 악영향(!)에 대해서 쓰려고 한다.


주석이 왜 필요하고 어떻게 작성해야 하는지는 다 아실테니, 오직 나쁜 점에 대해서만 말하겠다.



1. 당신을 바보로 만든다.

어떤 글이든 쓰려면 대상에 대해 제대로 알아야 한다.

주석도 마찬가지인데, 보통 자신이 잘 아는 내용에 대해 주석을 적는 경우는 적다.

내가 알면 남도 알 것이라고 생각하기 때문일 수도 있고, 너무나도 당연해서 귀찮을 수도 있다.

내가 "모르기 때문에", 또 "나중에도 모를 것"이기 때문에 작성하는 주석이 대부분이라면 반성이 필요하다.

그 때 필요한 것은 주석이 아니라 공부니까.



2. 착한 척을 한다.

정성스럽게 주석을 단 코드와 그렇지 않은 코드가 있다.

둘 중 하나에 오류가 있다.

어느 쪽을 의심할까?

주석은 우리를 안심하게 만든다.

주석이 있고 그 내용이 옳다고 해서 코드가 무결한 것은 아니다.



3. 게으름을 조장한다.

어떤 알고리즘을 구현했는데 눈으로는 이해가 어렵다고 하자.

그 때 우리는 친절하게 주석을 달아 기억력의 한계를 극복하거나 다른 작업자의 시간을 아껴주곤 한다. (별로 도움이 되지 않는다)

곰팡이가 핀 벽이 흉해서 그 위에 벽지를 바르면 어떻게 될까?

이해하기 어려운 코드에 필요한 조치는 주석이 아니라 재작성이다.


이상 좋은 주석을 작성하려면 알아야할 세 가지

ㅂㅂ

- dc official App