728x90 Javadoc1 4. 주석 잘 달린 주석은 그 어떤 정보보다 유용하다. 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨린다. 주석은 잘 해봐야 필요악이다. 개발자가 프로그래밍 언어를 제대로 사용할 능력이 있다면, 주석은 전혀 필요하지 않다. 개발자들은 코드의 의도를 표현하지 못해서 실패를 만회하기 위해 주석을 사용한다. 따라서 주석을 사용해야되는 상황이 올때마다 정말 코드를 통해 의도를 명확히 전달할 방법이 없는지를 우선적으로 생각해야 한다. 주석이 나쁜 이유는 주석이 코드를 따라가지 않기 때문이다. 코드는 지속적으로 변한다. 코드는 지속적으로 위치가 변하고 여러개로 쪼개지기도 한다. 하지만 주석은 이런 코드의 변화를 바라보기만 한다. 물론 주석 역시 엄격한 관리를 통해 코드의 .. 2022. 1. 10. 이전 1 다음 728x90