클린코드 4~5장

 

주제

• 클린코드 4~5장 요약

 

---

4장 "주석" 요약

잘 달린 주석

# 메모

주석 없이 이해할 수 없는 코드는 좋지 않은 코드다.

부정확한 주석은 안스니만 못함

 

코드에 주석을 추가한다고 코드 품질이 좋아지진 않음

표현력이 풍부하고 깔끔하고 주석이 거의 없는 코드 >>>> 복잡하고 어수선하며 주석이 많은 코드

코드만으로 의도를 설명하라

 

좋은 주석(정말 좋은 주석은 주석을 달지 않고 이해 가능한 것)

법적으로 넣어야 하는 주석

기본적인 정보를 제공하는 주석(정규식의 의미 설명)

의도를 설명하는 주석 (이건 이것 때문에 작성한 코드이다~... 이러한 조건이 있어 작성한 조건식이다 ... )

의미를 명료하게 밝히는 주석(a.eqauls(b) // a == b)

결과를 경고하는 주석 여유 ( //시간이 충분하지 않으면 실행하지 말라)

TODO 주석

중요성을 강조하는 주석

 

나쁜 주석

허술한 코드를 지탱, 변명, 합리화

주절거리는 주석 (성의가 없는 주석)

같은 이야기를 중복하는 주석 (코드 보다 많은 정보를 제공하지 않고 코드 그대로 설명)

의무적으로 다는 주석 (javadocs 때문에 일부러 다는 주석)

이력을 기록하는 주석(이거.. file template 쓰지말자)

있으나 마나 한 주석(// 기본 생성자)

함수나 변수로 표현할 수 있도록 주석을 달지 마라(코드로 표현하는 것이 우선)

닫는 괄호에 다는 주석

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

주석 처리된 코드는 그냥 지워라

HTML 주석 쓰지마라

코드 일부에 주석을 달면서 전반적인 정보를 기술하지 마라

너무 많은 정보를 늘어놓지 마라

 

 

# 요약

불필요한 주석을 달지말고 의미 있는 주석을 달아라

git이 없던 시절에서 이어져 오는 악습은 버려라

 

 

---

 

 

5장 "형식 맞추기" 요약

적절한 형식 맞추기

# 메모

코드 형식을 맞춰놓으면 가독성이 좋다

 

적절한 행 길이를 유지하라. (클래스의 Line 수)

200줄 정도로도 커다란 시스템을 구축할 수 있다.

 

신문 기사처럼 작성하라

이름만 보고 알 수 있다.

다양한 기사로 채워진다.

위에서 아래로 읽고, 문단을 나눠라

 

패키지 선언부, import문, 클래스 명 사이에는 빈 행이 들어가서 분리가 된다.

적절하게 개념을 빈 행으로 분리하라

빈 행은 새로운 개념을 시작한다는 시각적 단서이다.

 

열관성이 있는 코드는 세로로 가까이 붙여놔야 한다.

변수는 변수끼리 메소드는 메소드끼리

밀접한 개념은 세로로 가까이 둬라 (코드 찾으려 위아래 왔다갔다)

 

변수는 사용하는 위치에서 최대한 가깝게 선언하라

인스턴스 변수 : 논쟁이 있으나 맨 처음에

종속 함수 : 한 함수가 다른 함수를 호출한다면 서로 가깝게 배치 (다음 함수가 밑에)

개념적 유사성 : 비슷한 동작을 수행하면 가깝게

 

가로 형식 맞추기

오른쪽으로 스크롤 해야 하는 것은 좋지 않음

 

수식, ... 공백 이런건 뭐 IDE 자동 정렬에 의해 맞춰짐

 

들여쓰기를 잘 하자 (가독성)

 

 

# 요약

코드 형식을 맞추는 것은 예쁘게 블록을 쌓는 것과 같다