Community

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

← Go back
5. 형식 맞추기
#clean_code
2년 전
399

오늘 TIL 3줄 요약

  • 코드 형식은 의사소통의 일환이다.

  • 팀은 한가지 규칙에 합의해야 한다.

TIL (Today I Learned) 날짜

2022.05.02-03

오늘 읽은 범위

5장 형식 맞추기

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

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

  • 형식을 맞추는 목적

    • 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다

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

    • 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다. 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

    • 신문 기사처럼 작성하라

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

    • 개념은 빈 행으로 분리하라

      거의 모든 코드는 왼쪽에서 오른쪽으로 위에서 아래로 읽힌다. 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다.

    • 세로 밀집도

      줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.

    • 수직 거리

      서로 밀접한 개념은 세로로 가까이 둬야 한다. 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다. 여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.

      변수는 사용하는 위치에 최대한 가까이 선언한다. 인스턴스 변수는 클래스 맨 처음에 선언한다. 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다. 어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다. 친화도가 높을수록 코드를 가까이 배치한다. 예를 들어, 명명법이 똑같고 기본 기능이 유사하고 하다면 친화도가 높은 편이라고 할 수 있다.

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

  • 가로 형식 맞추기

    100-120자 정도로 행길이를 제한하는것을 추천한다. 그 이상은 주의부족이다. 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.

    소스파일은 윤곽도와 계층이 비슷하다. 계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다. 범위로 이루어진 계층을 표현하기 위해 우리는 코드를 들여쓴다. 들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.

  • 팀 규칙

    팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다. 개개인이 따로국밥처럼 맘대로 짜때는 코드는 피해야 한다.

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

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

혼자 개발을 하는 개발자는 형식의 중요성을 알면서도 혼자이기 때문에 형식을 지키기 어려운것 같다. 그리고 어떤 형식의 규칙이 좋은 규칙인지 고민하게 되는것 같고. 나는 이런 규칙에 불편함이 없지만, 팀은 불편할 수 있다는 점을 생각하기 어려웠던것 같다. 좀 더 나은 의사소통을 위한 코드 규칙을 혼자 개발한다고 하더라도 꼭 지키는 습관을 사이드 프로젝트를 하면서 만들어 봐야겠다. 마치 루틴을 만드는것 처럼?ㅎㅎ

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

오늘 읽은 다른사람의 TIL