[CleanCode]나쁜 주석

 

주절거리는 주석

주석이 주절거린다고 제가 만든 말이 아니라 책에 정말 나와있어요;

작성한 개발자가 아니며 이해가 안 되어 다른 모듈까지 뒤져야하는 주석은 좋지 않다.

---

같은 이야기를 중복하는 주석.
있으나 마나 한 주석

주석 없이도 읽을 수 있는 코드인 경우

Logger를 주석에 Logger가 적어두는 등

 

분풀이용 주석

---

오해의 여지
혹은
살짝 잘못된 정보가 담긴 주석

---

의무적으로 다는 주석

모든 함수에 주석을 달 필요는 없다. 메서드와 변수명만으로 코드를 알 수 있다면 주석이 필요 없다.

---

이력을 기록하는 주석

현재는 소스코드 관리 시스템이 있으니까 완전히 제거하는 편이 좋다.

2024.10.14 - [🛠 도구/➰ Visual Studio] - [VScode]GitLens

---

위치를 표시하는 주석

위치 표시대신 함수를 줄이는 노력을 하는 게 낫다.

닫는 괄호에 다는 주석도 마찬가지

---

공로를 돌리거나 저자를 표시하는 주석

---

주석으로 처리한 코드

이유가 있어 남겨놓았으리라 생각하기에 아무도 지울 수 없다.

---

HTML주석

그렇다고 한다.

아무 사이트나 가서 긴 HTML코드가 java에 적혀있다면 아찔할 것이다..

---

전역 정보

주석을 달 땐 근처에 있는 코드만 기술하라.

시스템 전반적 정보를 기술하지 않아야 한다.

ex) 포트값 정보 등

---

너무 많은 정보

---

모호한 관계

모호한 코드를 만들기 너무 어려워 책의 내용을 첨부한다.

---

함수 헤더

짦은 함수는 각 조건문마다 주석이 필요하지 않다.