[독후감] 읽기 좋은 코드가 좋은 코드다

읽코좋코

모든 전공 서적들이 빠르게 읽히지 않는데, 다른 전공서적에 비해 쉽게 읽히는 책이며 많은 공감을 하게 되었다. 제목과 내용은 동일하며 주제를 반복 강조하고 있다. 이를 위해 변수명, 함수명, 코드 컨벤션 그리고 리팩토링까지 설명하고 있다.
코드는 이해하기 쉬워야 한다, 다시 말해 코드를 읽는데 드는 비용을 줄여야 한다는 말이다. 코드 파악하는데 드는 비용이 작다는 말은 설계가 명확하고 간결하다는 의미를 내포한다.

이 책을 읽고 실제 코드로 적용할 생각을 하면 머리가 아프지만 읽는 중간 중간 이전에 보았던 코드들이 떠올랐다. 이전에 작성 했던 '성능과 가독성을 높이는 분기처리 방법'을 쓸 때 보다 시야가 더 넓어졌다. "왜?"에 대한 부분이 조금 모호했었는데, 그 부분을 채워주는 내용이였다. 그리고 내가 봐온 레거시 프로젝트들의 코드를 작성했던 개발자들에게 이 책을 던져주고 싶었다.

---

1. 코드는 이해하기 쉬워야 한다
   인상 깊었던 내용은 6개월 뒤의 나 자신 또한 쉽게 이해되도록 코드를 작성하라는 내용이였다. 나 역시도 나름의 설명과 주석을 잘 붙여서 만들었다고 생각했지만 1년 뒤 해당 코드를 개선 하면서 다시 분석해 보는 헛수고를 했던 경험이 있었다. 짧은 코드가 더 좋은 코드가 아닌 읽는 순간 바로 이해되는 코드가 좋은 코드라는 뜻이다.
2. 이름에 정보 담기
   • 구체적인 단어 사용하기
   • 이름 길이(짧은 범위에 잠깐 쓰이면 짧은 변수명, 사용 범위가 넓다면 긴 변수명, 약어 사용 지양하기 등)
   • 포맷팅으로 의미 전달하기(상수는 대문자, 클래스명은 카멜케이스 등)가 있었다.
3. 오해할 수 없는 이름들
   • 경계를 포함하는 범위 : first, last
   • 경계를 포함/배제하는 범위 : begin, end 사용
   • 불린 : is, has, can, should 사용
   • get 남발하지 않기
   • 여러 개의 이름을 후보로 놓고 고민하기
   • '다른 사람들이 다른 의미로 해석할 여지가 있는가?'가 핵심이였다. 한 번쯤 더 생각해 보면 더 좋은 변수명을 만들 수 있다.
4. 미학
   • 문서 작업을 하더라도 한눈에 보기 쉽게 쓰인 글이 잘 읽히듯 코드도 마찬가지다.
   • 좌우로 길게 늘어진 코드는 줄 바꿈을 하고 다른 코드들도 똑같이 맞추기
   • 헬퍼 메소드를 이용하여 지저분한 코드 깔끔하게 하기
   • 코드의 위아래 열을 맞추어 읽기 쉽게 하기
   • 코드의 순서를 '가장 중요한 것'에서 '가장 덜 중요한 것' 까지 순서대로 나열하기
   • 코드를 문단으로 만들기 (핸들러, DB 사용 등 문맥이 바뀌면 한 행을 띄우는 등 글을 쓸때 문단을 나누는 것과 동일)
   • 개인의 코드 스타일 VS 전체 코드의 일관성 = 일관성이 올바른 스타일보다 더 중요
5. 주석에 담아야 하는 대상
   • 불필요한 설명 배제
   • 나쁜 이름에 대한 변명이 아니라 좋은 이름으로 바꿀 것
   • 작업중 생각한 통찰 등을 주석에 기록
     • ex: 하위클래스로 정리해야 할 것 같다
   • 상수의 의미를 설명할 것
   • 다른 개발자가 실수할 수 있는 부분을 예상해서 주석을 달라
     • ex : 1분 후 타임아웃 된다
   • 2, 3중 반복/조건문이 달린 함수는 무엇을 위한 것인지 요약 주석을 단다
   • 주석을 다는 것에 대한 두려움을 버려라
6. 명확하고 간결한 주석 달기
   • 간단한 입출력 예시 사용
   • 코드의 수행 동작이 아니라 코드의 의도를 적어라
   • 파라미터에도 주석을 넣어라
   • 축약된 단어를 사용하라
     • ex : ~에서 불필요한 빈칸을 제거한다 -> 공백 제거
7. 읽기 쉽게 흐름 제어 만들기
   • 조건문에서 유동적인 값은 왼쪽, 상대적으로 고정적인 값은 오른쪽에 쓰라
   • if/else 간단한 것을 먼저 처리하라
   • 삼항 연산자의 사용은 간단하게 쓸 상황이 아니라면 피하라
   • 중첩을 피하기 위해 함수를 중간에서 반환하라
   • 2중 if 문은 나누어서 중간에 반환하라
8. 거대한 표현 잘게 쪼개기
   • 요약 변수 사용, 조건식의 반복되는 중요 비교 값을 상수로 만들기
   • 드모르간의 법칙 사용
   • short circuit 사용을 오용하지 말 것
     • 영리하게 작성된 코드가 혼란을 초래한다
   • 복잡한 논리를 간단하게 표현하기
   • 거대한 구문은 문맥에 따라 나누기
9. 변수와 가독성
   • 불필요한 임시 변수, 중간 결과 저장 변수, 흐름 변수(boolean) 제거하기
   • 변수의 범위 좁히기
   • 클래스를 작은 단위로 나누기
   • 전역변수 사용 피하기
   • 변수에 다른 값을 여러번 할당하는 것 피하기
10. 상관 없는 하위 문제 추출하기
    • 비즈니스 로직과 관계 없는 문자열 빈칸 제거, url 형식, 주소 형식등을 다루는 메소드는 분리하기
    • 재사용성을 위해 일반적인 목적을 가진 코드를 많이 만들기
    • 과유불급, 지나치게 나누지는 말기
11. 한 번에 하나씩
    • 작성된 코드가 읽기 어렵다면, 수행하는 작업을 나열하라
    • 나열된 작업중 분리될 수 있다면 별도의 함수 또는 클래스로 나눠라
    • 파편화를 최소화 할 수 있다.
12. 생각을 코드로 만들기
    • 논리를 명확하게 설명하기
    • 해결책을 말로 묘사하기
    • 언어에서 제공하는 라이브러리를 많이 사용해 보기
13. 코드 분량 줄이기
    • 필요가 없는 기능을 구현하려고 애쓰지 말것
    • 코드 베이스를 작게 유지할 것
    • 요구사항에 질문을 던져 요구사항을 잘게 나누어 분석하기.
    • 표준라이브러리와 친해지기
14. 테스트와 가독성
    • 테스트 코드는 특히 더 읽기 쉬워야 한다
    • 긴 테스트 내용은 다른 메소드로 만들기
    • 읽기 편한 에러 메세지 출력 폼 만들기
    • 좋은 테스트 입력 값 선택하기
    • 지금 작성하는 코드의 테스트 코드를 나중에 작성한다는 사실을 염두해 둘것
    • 지나친 테스트는 지양
15. 분/시간 카운터 설계 및 구현
    • 실습 예제