728x90
반응형
CHAPTER 04 주석
나쁜 코드에 주석을 달지 말고 새로 짜라
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다
코드로 의도를 표현하라
좋은 주석
- 법적인 주석
- 정보를 제공하는 주석
- 의도를 설명하는 주석
- 의미를 명료하게 밝히는 주석
- 결과를 경고하는 주석
- TODO 주석
- 중요성을 강조하는 주석
→ 주석을 달지 않고도 코드 만으로 충분히 의도를 표현할 수 있도록 클린한 코드를 짜야한다.
→ 주석이 많으면 코드에 집중하지 않게 된다. 코드에 집중하여 읽을 수 있도록 주석은 반드시 필요한 경우에만 사용한다.
728x90
반응형
'clean code' 카테고리의 다른 글
| [클린코드] CHAP 06 객체와 자료구조로 데이터 표현하기 (0) | 2022.06.13 |
|---|---|
| [클린코드] CHAP 05 형식 맞추기 (0) | 2022.06.13 |
| [클린코드] CHAP 03 함수 (0) | 2022.06.13 |
| [클린코드] CHAP 02 의미 있는 이름 (0) | 2022.06.13 |
| [클린코드] CHAP 01 깨끗한 코드 (0) | 2022.06.13 |
