Community

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

← Go back
[TIL] 5장. 형식 맞추기
by xgro
#clean_code
2년 전
899

오늘 TIL 3줄 요약

  • 코드 자체가 최고의 구현 표준 문서가 되는 예를 따른다.

  • 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.

  • 의사소통은 전문 개발자의 일차적인 의무다.

TIL (Today I Learned) 날짜

2022. 05. 02

오늘 읽은 범위

5장. 형식 맞추기

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

  • 형식을 맞추는 목적

    • 코드형식은 중요하다!

    • 너무나도 중요하므로 융통성 없이 맹목적으로 따르면 안 된다.

    • 의사소통은 전문 개발자의 일차적인 의무다.

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

  • 신문 기사처럼 작성하라

    • 독자는 위에서 아래로 기사를 읽는다.

    • 독자는 표제를 보고서 기사를 읽을지 말지 결정한다.

    • 첫 문단은 전체 기사 내용을 요약한다.

    • 소스 파일도 신문 기사와 비슷하게 작성한다.

    • 이름은 간단하면서도 설명이 가능하게 짓는다.

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

    • 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.

  • 세로 밀집도

    • 세로 밀집도는 연관성을 의미한다.

  • 수직거리

    • 서로 밀접한 개념은 세로로 가까이 둬야 한다.

    • 변수선언 :

      변수는 사용하는 위치에 최대한 가까이 선언한다.

    • 인스턴스 변수 :

      인스턴수 변수는 클래스 맨 처음에 선언한다.

    • 종속 함수 :

      한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.

    • 개념적 유사성 :

      친화도가 높을수록 코드를 가까이 배치한다.

    • 세로 순서 :

      일반적으로 함수 호출 종속성은 아래 방향으로 유지한다.

  • 가로 형식 맞추기

    • 프로그래머는 명백하게 짧은 행을 선호 한다.

  • 가로 공백과 밀집도

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

    • 가로 정렬

      • 선언문과 할당문을 별도로 정렬하지 않는다.

      • 정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.

    • 들여쓰기

      • 프로그래머는 이런 들여쓰기 체계에 의존한다.

      • 왼쪽으로 코드를 맞춰 코드가 속하는 범위를 시각적으로 표한한다.

    • 들여쓰기 무시하기 : 한 행에 범위를 뭉뚱그린 코드를 피한다.

    • 가짜 범위 : 피하지 못할 때는 빈 블록을 올바로 들여쓰고 괄호로 감싼다.

  • 팀 규칙

    • 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.

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

    • 모든 팀원은 그 규칙을 따라야 한다.

  • 밥 아저씨의 형식 규칙

    • 코드 자체가 최고의 구현 표준 문서가 되는 예를 따른다.

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

  • 제일 중요한 내용이 가장 마지막에 나온거 같다. '팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.'

  • 로마에 가면 로마법을 따르듯이, 소속된 팀 내에서 합의를 통해서 이루어진 규칙을 기준으로 코드를 작성할 것이다.

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

오늘 읽은 다른사람의 TIL