[클린코드] 4. 주석

목차 1. 주석을 최대한 쓰지 말자. 2. 좋은 주석 3. 나쁜 주석 4. 주석보다 annotation 5. JavaDoc 1. 주석을 최대한 쓰지 말자. 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않다. 대부분 주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다. 따라서 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로 에너지를 쏟아야 한다. 코드는 변화하고 진화한다. 주석은 언제나 코드를 따라가지는 않는다. 코드만이 자기가 하는 일을 진실되게 말한다. 따라서 주석을 가능한 줄이도록 꾸준히 노력해야 한다. 1) 주석은 나쁜 코드를 보완하지 못한다. 표현력이 풍부하고 깔끔하면 주석이 거의 없는 코드가 복잡하고 어수선하며 주석이 많이 달린 ..
책 내용 정리/클린코드(clean code) 2022. 1. 17. 17:15
1