Clean Code - 1주차

이번 주 목차 
1장 깨끗한 코드
2장 의미 있는 이름
3장 함수
4장 주석

책 선정 이유

 

- 좋은 코드란 무엇일까? 왜 다들 클린 코드를 추천할까? -> 읽어봐야겠다.

깨끗한 코드란 무엇인가? 

위의 목차를 읽고 깨끗한 코드가 무엇인지 요약을 한다면 나는 "읽기 쉬운 코드"라고 요약하고 싶다.
책의 나온 내용에 덧붙이면 한 번에 이해 가능한 변수 이름, 복잡하지 않은 단순한 함수, 잘 정리된 클래스이다.

나는 그동안 변수 이름을 잘 짓지도 못했고, 단순한 길도 돌고 돌아간 적도 많았고, 반복한 적도 있었다. 
하지만 이제는 로버트 c.마틴(클린 코드의 저자)에게 많은 잔소리를 들었기에 읽기 쉬운 코드로 작성하게 노력할 것이다.

읽다 보니 아래와 같은 구절이 있었다.

 

주변 코드가 읽기 쉬우면 새 코드를 짜기도 쉽다.
주변 코드를 읽기 어려우면 새 코드 짜기도 어렵다.
그러므로 급하다면, 서둘러 끝내려면, 쉽게 짜려면, 읽기 쉽게 만들면 된다.

 

좋은 구절이다.
읽기 쉬운 코드를 만들면 된다니 정말 단순하다.
읽기 쉬운 코드는 좋은 후임 개발자를 양성할 수 있다.

개발자 선배님이 지나가시는 말로 "개발 라인별로 코드 스타일이 다르다"라고 말씀하신 적이 있다.
왜일까? 처음 개발을 배우는 입장에서는 선배님의 코드를 읽어가면서 개발하면서 선배님의 코드를 따라가기 때문이다.
그렇기에 읽기 쉬운 코드를 남겨야 후임 개발자도 좋은 코드의 길로 따라갈 수 있다.
(난 기초가 너무 약해 중간에 몇 번 길을 많이 헤맸다)

2장에서는 작명을 위한 원칙을 세워준다.

1. 의도를 분명히 밝혀라.
2. 그릇된 정보를 피하라.
3. 의미 있게 구분하라.
4. 발음하기 쉬운 이름을 사용하라.
5. 검색하기 쉬운 이름을 사용하라.
6. 인코딩을 피하라.
7. 자신의 기억력을 자랑하지 마라.
8. 기발한 이름은 피하라.
9. 한 개념에 한 단어를 사용하라.
10. 말장난을 하지 마라.
11. 해법 영역에서 가져온 이름을 사용하라.
12. 문제 영역에서 가져온 이름을 사용하라.
13. 의미 있는 맥락을 추가하라.
14. 불필요한 맥락을 없애라.

내가 느끼기에는 변수명 및 함수명은 객관적으로 짓는 게 가장 최선인 것 같다.
항상 짓고 나면 후회가 살짝 남지만, 객관적으로 지을 경우 후회가 가장 적었다.

커밋전에 항상 하는 작업이 있다.
주석 남기기.
때로는 과하게 주석을 남길 때가 있었다.
예를 들면 함수명으로 이미 해석이 가능한데 주석으로 과하게 남겼다.
(이젠 그러지 말아야지..)
책에서는 꼭 필요한 곳에서만 남기라 조언을 해주고 있다.

하지만, SI 같은 곳에서는 과한 친절이 더 좋을때도 있다.
인원이 자주 교체되고 주니어가 자주 들어오는 곳이라면, 주니어를 위해서라도 친절하게 남겨주는게 좋다.


추가
- 함수당 추상화는 한가지만 사용하라.
- 함수를 반복하지마라.