주석은 다른 사람을 위해 쓰는 것이라는 말, 절반만 맞다.
코드를 짜다가 막히는 순간을 떠올려보면, 대부분 내가 지금 무엇을 하려는지 흐릿해진 상태다. 주석을 먼저 쓰는 습관은 이 문제를 해결한다. 코드를 작성하기 전에 각 줄이 무엇을 해야 하는지 한국어로 주석으로 적고, 그 다음에 코드를 채우는 방식이다.
주석 먼저 쓰는 방식의 실제 효과
이 방식을 쓰면 코딩 중간에 방향을 잃는 빈도가 줄어든다. 특히 20줄 이상의 코드를 작성할 때 차이가 분명하다. 주석이 일종의 설계도 역할을 하기 때문이다.
바쁜 사람에게 또 다른 장점이 있다. 며칠 후 같은 코드를 다시 열었을 때, 주석 없는 코드는 처음부터 다시 읽어야 한다. 주석이 있으면 30초 안에 맥락을 되찾을 수 있다. 입문 단계부터 이 습관을 들이면, 나중에 팀 프로젝트에서 따로 노력하지 않아도 자연스럽게 협업 친화적인 코드를 쓰게 된다.