Clean Code (주석)

최태선·2022년 3월 28일
0

CleanCode

목록 보기
2/4

주석은 코드로 의도를 표현하지 못해 실패를 만회하기 위해 쓰는 것이다.

우리는 주석을 최대한 줄이도록 노력해야한다.

좋은 주석

1) 법적인 주석
2) 정보를 제공하는 주석
3) 의도를 설명하는 주석
4) 의미를 명료하게 밝히는 주석
5) 결과를 경고하는 주석
6) TODO 주석
7) 중요성을 강조하는 주석
8) 공개 API docs

나쁜주석

1) 주절거리는 주석(프로그래머 자기만 아는 주석)
2) 코드와 같은 이야기를 중복하는 주석 - 코드읽는게 주석읽는것보다 쉽다
3) 오해할 여지가 있는 주석
4) 의무적으로 다는 주석
5) 이력을 기록하는 주석
6) 있으나 마나 한 주석 - 당연한걸 왜써?
7) 함수나 변수로 표현할 수 있다면 주석을 달지마라
8) 위치를 표시하는 주석
9) 닫는 위치에 다는 주석 - 엄청 긴 괄호가 아니라면 무의미
10) 저자를 표시하는 주석
11) 주석으로 처리한 코드는 바로 지워버려라
12) html 주석
13) 전역 정보 - 주석을 달아야 한다면 근처에 있는 코드만 기술해라.
14) 너무 많은 정보
15) 모호한 관계 - 코드랑 주석이랑 따로논다
16) 함수헤더
17) 비공개 API docs

profile
최태선입니다

0개의 댓글