클린코드 (Clean Code) 4장 (주석) 독후감

클린코드 4장 독후감

Chapter 4. 주석

 

4.1 주석은 나쁜 코드를 보완하지 못한다

 - 코드에 추석을 추가하는 이유는 코드가 좋지 못하거나 자세한 설명이 필요한 경우이다. 자세히 설명하는 주석보다 깔끔한 코드가 백 번 낫다.

4.2 코드로 의도를 표현하라

 - 코드만으로 코드의 동작과 기능을 설명하기 어려운 경우가 존재한다. 

그런데 아래 두 코드들 중 어떤 코드가 더 나은가?

# 직원이 모든 조건을 만족했는지 확인
if ((employee.flags and HOURLY_FLAG) and (employee.age > 65):

if(employee.isEligibleForFullBenefits()):

 

4.3 좋은 주석

 - 법적인 주석

 - 정보를 제공하는 주석

 - 의도를 설명하는 주석

 - 의미를 명료하게 밝히는 주석

 - 결과를 경고하는 주석

 - TODO 주석

 - 중요성을 강조하는 주석

 - 공개 API에서 Javadocs

 

4.4 나쁜 주석

 - 주절거리는 주석

 - 같은 이야기를 중복하는 주석

 - 오해할 여지가 있는 주석

 - 의무적으로 다는 주석

 - 이력을 기록하는 주석

 - 있으나 마나 한 주석

 - 무서운 잡음

 - 함수나 변수로 표현할 수 있다면 주석을 달지 마라

 - 위치를 표시하는 주석

 - 닫는 괄호에 다는 주석

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

 - 주석으로 처리한 코드

 - HTML 주석

 - 너무 많은 정보

 - 모호한 관계

 - 함수 헤더

 - 비공개 코드에서 Javadocs

"깨끗한 코드를 작성하려면 힘겹게 습득한 감각으로 기법들을 적용하는 절제와 규율이 필요하다. '코드 감각'은 존재한다. 어떤 사람은 '코드 감각'을 타고난다. 어떤 사람은 많은 시행착오를 통해 얻는다. '코드 감각'이 있는 사람이라면, 나쁜 코드를 깨끗한 코드로 바꿀 수 있다."

 

 

 

 

<다른 사람의 독후감 영상>

www.youtube.com/watch?v=6OUqPRj-9oM&list=PL4KdJM8LzAMfSrWJldnGuU9O1EpsVbXZJ&index=4&ab_channel=KunalCholera