좋은 주석
법적인 주석
때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다. 예를 들어, 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.
의미를 명료하게 밝히는 주석
인수나 반환 값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 중요하다.
TODO 주석
TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다. 더 이상 필요 없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용하다.
'독서록 > Clean Code' 카테고리의 다른 글
| [Clean Code] 6장 객체와 자료 구조 (0) | 2022.04.20 |
|---|---|
| [Clean Code] 5장 형식 맞추기 (0) | 2022.04.19 |
| [Clean Code] 3장 함수 (0) | 2022.04.14 |
| [Clean Code] 2장 의미 있는 이름 (0) | 2022.04.12 |
| [Clean Code] 1장 깨끗한 코드 (0) | 2022.04.11 |