[Clean Code] 요약 (1)

1. Clean Code 란?

사람마다 Clean한 기준이 다르다. 책의 멘토가 전하는 Clean Code는 다음과 같다.

나는 우아하고 효율적인 코드를 좋아한다. 논리가 간단해야 버그가 숨어들지 못한다. 의존성을 최대한 줄여야 유지보수가 쉬워진다. 오류는 명백한 전략에 의거해 철저히 처리한다. 성능을 최적으로 유지해야 사람들이 원칙 없는 최적화로 코드를 망치려는 유혹에 빠지지 않는다. 깨끗한 코드는 한 가지를 제대로 한다. - C++ 창시자 Bjarne Stroustrup -

깨끗한 코드는 단순하고 직접적이다. 깨끗한 코드는 잘 쓴 문장처럼 읽힌다. 깨끗한 코드는 결코 설계자의 의도를 숨기지 않는다. 오히려 명쾌한 추상화와 단순한 제어문으로 가득하다. - Object Oriented Analysis and Design with Application 저자 Grady Booch -

깨끗한 코드는 작성자가 아닌 사람도 읽기 쉽고 고치기 쉽다. 단위 테스트 케이스와 인수 테스트 케이스가 존재한다. 깨끗한 코드에는 의미있는 이름이 붙는다. 특정 목적을 달성하는 방법은 하나만 제공한다. 의존성은 최소이며 각 의존성을 명확히 정의한다. API는 명확하며 최소로 줄였다. 언어에 따라 필요한 모든 정보를 코드만으로 명확히 표현할 수 없기에 코드는 문학적으로 표현해야 마땅하다. - OTI 창립자이자 이클립스 전략의 대부 Dave Thomas -

깨끗한 코드의 특징은 많지만 그 중에서도 모두를 아우르는 특징이 하나 있다. 깨끗한 코드는 언제나 누군가 주의 깊게 짰다는 느낌을 준다. 고치려고 살펴봐도 딱히 손 댈 곳이 없다. 작성자가 이미 모든 사항을 고려했으므로. 고칠 궁리를 하다보면 언제나 제자리로 돌아온다. 그리고는 누군가 남겨준 코드, 누군가 주의 깊게 짜놓은 작품에 감사를 느낀다. - Working Effectively with Legacy Code 저자 Michael Feathers -

최근 들어 나는 켄트 벡이 제안한 단순한 코드 규칙으로 구현을 시작한다. 중요한 순으로 나열하자면 간단한 코드는 '모든 테스트를 통과한다.', '중복이 없다.', '시스템 내 모든 설계 아이디어를 표현한다.', '클래스, 메서드, 함수 등을 최대한 줄인다.' ...(생략) - Extreme Programming Installed와 Extreme Programming Adventure in C# 저자 Ron Jeffries -

코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다. 코드가 그 문제를 풀기 위한 언어처럼 보인다면 아름다운 코드라 불러도 되겠다. - 위키 창시자, 익스트림 프로그래밍 공동창시자 Ward Cunningham -

이 책은 우리 오브젝트 멘토 진영이 생각하는 깨끗한 코드를 설명한다. 여기서 가르치는 교훈과 기법은 우리 진영이 믿고 실천하는 교리다. ...(생략) 우리가 가르치는 기법을 따른다면 깨끗하고 수준 높은 코드를 작성하리라 감히 장담한다. - Clean Code 저자 Robert C. Martin -

요약하자면 공통적으로 멘토들이 추구하는 Clean Code는 다음과 같다.

• 의미있는 테스트, 명시적인 네이밍, 최소한의 의존성이어야 한다.
• 작성자가 아닌 사람도 읽기 쉽고 고치기 쉬워야한다.
• 개발자들이 해당 코드를 읽으면서 짐작한 대로 동작할 수 있어야 한다.

 

다른 말로 풀어본다면, 클린 코드는 글을 잘쓰는 것과 동일하다.

• 띄어쓰기가 되어있지 않다. (코딩 컨벤션)
• 불필요한 사설이 붙어있다. (주석)
• 어려운 용어를 사용한다. (네이밍)
• 문장이 너무 길고 장황하다. (클래스/메서드 길이)

 

즉, 읽기 쉬운코드, 전달하고자 하는 바를 명확하게 알려주는 코드, 개발자의 의도가 모두 담겨있는 코드가 Clean Code라고 할 수 있다.

 

 

 

2. Clean Code가 필요한 이유 ?

혼자서 하나의 프로젝트를 모두 개발하는 시대는 지나고 개발 뿐만 아닌 협업 능력을 발전시켜야 하는 시대이다. 실제로 현업의 경우에도 프로젝트를 처음 시작하는 경우, 스타트업을 시작하는 경우를 제외하고는 본인의 코드보다 다른 사람의 코드를 읽는 시간이 훨씬 많아졌다. 코드를 만드는 시간을 단축하는 것도 중요하지만, 다른 사람이 코드를 읽는 시간을 줄여주는 것이 더욱 중요해졌다.

 

본인이 수행해야하는 기능에 대해 코드를 만드는 시간이 증가해도, 해당 코드를 읽는 팀원 개발자가 읽는 시간이 줄어든다면 전체적인 개발 효율성은 증가한다.

 

 

 

3. Clean Code를 학습하는 방법 ?

책을 읽고 보편적으로 어떤 코드가 좋은 코드인지 확인해야한다.

 

학습을 원활하게 진행하기 위해서는, 직접 적용해보아야 한다.

• 내가 담당하는 프로젝트를 리팩토링
• 새로 만드는 코드를 Clean Code룰에 맞춰 제작
• 프로젝트에 맞는 Clean Code 룰을 정의

 

좋은 코드를 계속 읽는 습관이 필요하다.

• 담당하고 있는 프로젝트에서 좋은 코드 찾아보기
• 오픈 소스로 제공하는 코드에서 좋은 코드를 찾아보기

 

Clean Code를 책을 읽을 때에는 각 장이 독립적으로 되어있기 때문에 읽으면서 계속 실제로 적용해보고 코딩 연습을 해보는 것이 좋다.

챕터	내용
1장	깨끗한 코드
좁은 범위의 클린코드
2장	의미있는 이름
3장	함수
4장	주석 (최근은 주석처리를 지양하는 추세이다.)
5장	형식 맞추기 (최신 IDE에서 잘 지원하고 있다.)
넓은 범위의 클린코드
6장	객체와 자료구조
7장	오류 처리
8장	경계
9장	단위 테스트
10장	클래스
더 넓은 범위의 클린코드
11장	시스템
12장	창발성
13장	동시성
14장	점진적인 개선
추가적인 클린코드
15장	JUnit 들여다보기
16장	SerialDate 리팩토링
17장	냄새와 휴리스틱