#5. 훌륭한 프로그래머는 스스로 설명하는 코드를 만든다

2018-01-05 1 분 소요

맞는 말입니다.

저도 공감하고, 스스로 설명하는 코드를 작성하기 위해 많은 노력을 합니다.

하지만 어떤 분은 자신의 코드에 모든 정보와 설명을 담아놓았기 때문에 주석을 작성할 필요가 없다고 하더군요. 자신의 코드에 모든 정보가 담겨있다고 생각하면서 말이죠…

사실 아무리 훌륭한 프로그래머라도 코드에 담을 수 없는 정보가 있습니다.

그래서 아무리 훌륭한 프로그래머라도 주석은 작성할 수 밖에 없습니다.

또 만약, 팀원 중에 주석을 작성하자는 말이 나오면, 절대로 다음과 같은 말로 반박하지 마세요.

“훌륭한 프로그래머는 스스로 설명하는 코드를 만든다. 코드에 모든 정보가 담겨 있어야 한다. 그래서 주석은 불필요하다.”

팀원에게 다음의 뜻밖의 말을 들을지도 모릅니다.

“그건 저도 알지만, 당신은 훌륭한 프로그래머가 아닙니다. 당신의 코드는 명쾌하지 않으니, 주석을 적으세요.”

이러면 싸우자는 거죠. 이러시지들 마시고요,

당신의 자존심을 지켜주기 위해 팀원이 우회적으로 주석을 작성하자고 한 것일 겁니다. 아마도 그 팀원은 당신의 코드를 이해하기 위해 몇시간씩 머리를 쥐어짜고, 고민끝에 그런 얘기를 꺼냈을 수도 있습니다.

주석을 적자고 우회적으로 말한 팀원에게 자존심을 지켜줘서 고맙다고 말하는게 좋지 않을까 싶기도 하네요.

설령 당신이 훌륭한 프로그래머라고 할지라도, 다른 팀원은 당신만큼 훌륭하지 못하기 때문에 코드를 이해하지 못할 수도 있습니다. 그들을 위해서라도 주석을 작성하는 것이 좋습니다. 후학을 위한 배려죠.

그럼 훌륭한 프로그래머가 되는 그날까지 열심히 주석을 적고, 또 주석이 없어지도록 리팩토링 합시다.

잊지마세요.