1장. 깨끗한 코드
깨끗한 코드란?
나는 우아하고 효율적인 코드를 좋아한다. 논리가 간단해야 버그가 숨어들지 못한다. 의존성을 최대한 줄여야 유지보수가 쉬워진다. 오류는 명백한 전략에 의거해 철저히 처리한다. 성능을 최적으로 유지해야 사람들이 원칙 없는 최적화로 코드를 망치려는 유혹에 빠지지 않는다. 깨끗한 코드는 한 가지를 제대로 한다.
- 비야네 스트롭스트룹 / C++ 창시자이자 The C++ Programming Language 저자
- 철저한 오류 처리도 언급하는 이유는 세세한 사항까지 꼼꼼하게 신경쓰라는 말.
- 메모리 누수, 경쟁 상태(race condition), 일관성 없는 명명법 등 도 포함
- 즉, 깨끗한 코드는 세세한 사항까지 꼼꼼하게 처리하는 코드
깨끗한 코드는 단순하고 직접적이다. 깨끗한 코드는 잘 쓴 문장처럼 읽힌다. 깨끗한 코드는 결코 설계자의 의도를 숨기지 않는다. 오히려 명쾌한 추상화와 단순한 제어문으로 가득하다.
- 그래디 부치 / Object Oriented Analysis and Design with Application 저자
깨끗한 코드는 작성자가 아닌 사람도 읽기 쉽고 고치기 쉽다. 단위 테스트 케이스와 인수 테스트 케이스가 존재한다. 깨끗한 코드에는 의미 있는 이름이 붙는다. 특정 목적을 달성하는 방법은 (여러 가지가 아니라) 하나만 제공한다. 의존성은 최소이며 각 의존성을 명확히 정의한다. API는 명확하며 최소로 줄였다. 언어에 따라 필요한 모든 정보를 코드만으로 명확히 표현할 수 없기에 코드는 문학적으로 표현해야 마땅하다.
- 큰 데이브 토마스 / OTI 창립자이자 이클립스 전략의 대부
깨끗한 코드의 특징은 많지만 그 중에서도 모두를 아우르는 특징이 하나 있다. 깨끗한 코드는 언제나 누군가 주의 깊게 짯다는 느낌을 준다. 고치려고 살펴봐도 딱히 손 댈 곳이 없다. 작성자가 이미 모든 사항을 고려했으므로, 고칠 궁리를 하다보면 언제나 제자리로 돌아온다. 그리고는 누군가 남겨준 코드, 누군가 주의 깊게 짜놓은 작품에 감사를 느낀다.
- 마이클 페더스 / Working Effectively with Lagacy Code 저자
최근 들어 나는 켄트 벡이 제안한 단순한 코드 규칙으로 구현을 시작한다. (그리고 같은 규칙으로 구현을 거의 끝낸다.) 중요한 순으로 나열하자면 간단한 코드는
- 모든 테스트를 통과한다.
- 중복이 없다.
- 시스템 내 모든 설계 아이디어를 표현한다.
- 클래스, 메서드, 함수 등을 최대한 줄인다.
.... - 론 제프리스 / Extreme Programming Installed와 Extreme Programming Adventure in C# 저자
- 같은 작업을 여러 차례 반복한다면 코드가 아이디어를 제대로 표현하지 못한다는 증거.
- 객체가 여러 기능을 수행한다면 여러 객체로 나눠라.
- 메서드가 여러 기능을 수행한다면 메서드 추출 리팩터링 기법을 사용하라.
- 중복과 표현력만 신경 써도 깨끗한 코드 목표에 성큼 다가감.
- 즉, 중복을 피하라, 한 기능만 수행하라, 제대로 표현하라, 작게 추상화하라.
코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다. 코드가 그 문제를 풀기 위한 언어처럼 보인다면 아름다운 코드라 불러도 되겠다.
우리는 저자이자 독자이다.
- 코드 작성자는 저자이며, 코드를 읽는 사람은 독자이다. 저자는 독자와 잘 소통할 책임이 있다.
- 새 코드를 짜면서 우리는 끊임없이 기존 코드를 읽는다.
보이스카우트 규칙
- 체크아웃할 때보다 좀 더 깨끗한 코드를 체크인한다면 코드는 절대 나빠지지 않는다.
- 한꺼번에 많은 시간과 노력을 투자해 코드를 정리할 필요가 없다.
- 변수 이름 하나를 개선하고, 조금 긴 함수 하나를 분할하고, 약간의 중복을 제거하고, 복잡한 if문 하나를 정리하면 충분하다.
프리퀄과 원칙
- SOLID
'Book' 카테고리의 다른 글
[만들면서 배우는 클린 아키텍처] 1. 계층형 아키텍처의 문제는 무엇일까? (2) | 2022.01.22 |
---|---|
[클린코드] 2장. 의미 있는 이름 (0) | 2021.10.04 |
[SQL 첫걸음] 1장. 데이터베이스와 SQL (0) | 2021.09.22 |
[함께 자라기] 3장. 애자일 (0) | 2020.10.01 |
[함께 자라기] 2장. 함께 (0) | 2020.10.01 |