어노테이션
-
♻️[클린코드] #3 주석Study/클린코드 2022. 5. 23. 15:34
♻️ 주석을 최대한 쓰지 말자 - 주석은 나쁜 코드를 보완하지 못한다. 코드에 주석을 추가하는 일반적인 이유 -> 코드 품질이 나쁘기 때문에 설명하려고 주석을 작성하는 경우이다. 주석을 작성할 시간에 코드를 알아듣기 좋게 개선하는데 시간을 보내는 것이 좋다. ex) 코드를 함수로 분리해서, 함수 이름으로 코드의 의도를 표현한다. - 주석은 방치된다. 요구사항에 따른 코드의 변화가 생길 때 주석은 따라가지 못한다. 주석은 그저 주석이기 때문에 컴파일 되지 않고 방치된다. 결국 나중에 의미없는 텍스트가 된다. ♻️ 좋은 주석 주석을 쓸거라면 좋은 주석을 쓰자! - 구현에 대한 정보를 제공한다. 출력 포맷에 대한 정보를 제공 ex) 날짜 출력 형식 주석으로 표시 - 의도와 중요성을 설명한다. ex) 스레드를 ..