Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
[TIL / Clean Code] 5장. 형식 맞추기
#clean_code
2년 전
564


TIL (Today I Learned)

2022.02.28

오늘 읽은 범위

5장. 형식 맞추기

책에서 기억하고 싶은 내용을 써보세요.

  • 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.(96p)

  • 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.(96p)

  • 적절한 행 길이를 유지하라.

    • 이름은 간단하면서도 설명이 가능하게 짓는다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.(98p)

    • 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.(100p)

    • 서로 밀접한 개념은 세로로 가까이 둬야 한다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다. 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 이게 바로 protected 변수를 피해야 하는 이유 중 하나다.(101p)

    • 변수와 함수는 사용되는 위치에 가깝게 정의한다.(376p)

    • 변수는 사용하는 위치에 최대한 가까이 선언한다.(101p)

    • 인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 많은 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.(103p)

    • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.(104p)

    • 친화도가 높을수록 코드를 가까이 배치한다.(106p)

    • 일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다. 그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.(106p)

  • 가로 형식 맞추기

    • 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.(108p)

    • 들여쓰기(111p)

  • 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.(114p)

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

  • 5장은 읽으면서 매우 공감이 되었다. 평소 나의 스타일이 잘못되지 않았다는 것을 느꼈다. 가끔 후배의 코드를 읽으며 정리해주는 경우가 있는데, 대부분이 가독성이 떨어지는 코드로 인한 정렬 규칙 등이었다. 이런 경험도 있으니, 더욱더 공감하며 읽을 수 있었다. 

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.