[잇타] 클린코드 스터디 4주차

클린코드 4장 - 주석

 

❗주석에 대하여

주석이 필요한 상황에 처하면 곰곰이 생각해야 한다. 반대로 생각해서 반대로 코드로 의도를 표현할 방법이 없는지 생각해야 한다. 코드로 의도를 표현할 때마다 스스로 칭찬하며 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.

프로그래머들이 주석을 유지하고 보수하는 것은 현실적으로 불가능하기 때문에 주석이 코드와 분리되어 의미가 전해지지 않는 경우도 많이 존재한다. 그래서 프로그래머들이 주석을 엄격하게 관리하고 복구성과 관련성, 정확성이 언제나 높아야 한다고 주장할지도 모르지만 필자는 표현력을 강화해서 주석이 필요없는 방향으로 에너지를 쏟는 게 낫다고 생각한다. 

 

❗주석은 나쁜 코드를 보안하지 못한다

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다

 

❗좋은 주석

- 의도를 설명하는 주석: 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.

-결과를 경고하는 주석

-TODO 주석: 앞으로의 할 일을 주석으로 남겨두면 편리하다. 프로그래머가 필요하다고 여기지만 당장 구현하기 어려운 업무를 기술한다.

-중요성을 강조하는 주석: 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다. 

 

❗나쁜 주석

-주절거리는 주석: 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간 낭비이다. 한 번 주석을 남기려면 시간을 들여 최고의 추석을 달도록 노력해야 한다.

-오해의 여지가 있는 주석: 때때로 의도는 좋았으니 프로그래머가 딱 맞을 정도로 엄밀하게 주석을 달지 못하기도 한다. 

-있으나 마나 한 주석: 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.

-주석으로 처리한 코드: 주석으로 처리된 코드는 남겨놓은 이유가 있을 것이라고 생각해서 사람들이 지우기를 주저한다. 

 

---

 

❗4장 읽은 후기

지금껏 오히려 주석을 적어주면 다른 사람의 코드에 대한 이해도를 높여줄 수 있다고 생각했었다. 하지만 이 책에서는 오히려 주석을 적어 표현하는 것은 잘못된 것이고 이 주석마저도 코드에 전부 흡수시켜서 코드로만 표현해야 한다고 하는 것에 대해 다시 생각해본 기회가 된 것 같다. 

---

// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile() {

}