Community

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

← Go back
TIL 5장. 형식 맞추기
#clean_code
2년 전
521


TIL (Today I Learned)

2022.03.01

오늘 읽은 범위

5장. 형식 맞추기

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

  • 형식을 맞추는 목적 - 코드 형식은 의사소통의 일환이기 때문이다

  • 적절한 행 길이를 유지하라
    1. 신문 기사처럼 작성하라 - 소스파일 첫 부분은 고차워 개념과 알고리즘을 설명하고, 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에서 가장 저차원 함수와 세부내역이 나온다


    2. 개념은 빈 행으로 분리하라 - 빈 행은 새로운 개념을 시작한다는 시각적 단서다
    3. 세로 밀집도 - 서로 밀집한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다
    4. 수직 거리 - 서로 밀접한 개념은 세로로 가까이 둬야한다. 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다(연관성 : 한 개념을 이해하는데 다른 개념이 중요한 정도)

  • 변수 선언 - 변수는 사용하는 위치에 최대한 가까이 선언한다. 짧은 함수에서 지역변수는 각 함수 맨 처음에 선언한다

  • 인스턴트 변수 - 클래스 맨 처음에 선언한다.
    1. C++에서는 모든 인스턴스 변수를 클래스 마지막에 선언한다는 가위 규칙을 적용한다
    2. 자바에서는 클래스 맨 처음에 인스턴스 변수를 선언한다.


    잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요하다. 변수 선언을 어디서 찾을지 모두가 알 수 있어야한다.

  • 종속 함수 - 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.

  • 개념적 유사성 - 친화도가 높을수록 코드를 가까이 배치한다.
    #친화도가 높은 요인
    1. 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성
    2. 변수와 그 변수를 사용하는 함수


    3. 비슷한 동작을 수행하는 일군의 함수

  • 세로 순서 - 가장 중요한 개념을 가장 먼저 표현한다. 세세한 사항은 가장 마지막에 표현한다.

  • 가로 형식 맞추기 - 홀러리스는 80자 제한을 했지만 다소 인위적이고, 100자~120자에 달해도 나쁘지 않다. 그 이상은 솔직히 주의부족이다.
    #가로 공백과 밀집도
    1. 할당연산자를 강조하려고 앞뒤에 공백을 준다.
    2. 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다. 함수와 인수는 서로 밀접하기 때문이다.


    3. 함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리했다. 쉼표를 강조해 인수가 별개라는 사실을 보여준다.
    4. 승수 사이에는 공백이 없다. 곱셈은 우선순위가 가장 높기 때문이다
    5. 항 사이에는 공백이 들어간다. 덧셈과 뺄셈은 우선순위가 곱셈보다 낮기 때문이다.
    #가로 정렬
    #들여쓰기 - 들여쓰기한 파일은 구조가 한눈에 들어온다.
    #들여쓰기 무시하기 - 간단한 if문, while, 함수에서 들여쓰기를 무시하고픈 유혹이 생기지만, 들여쓰기로 범위를 제대로 표현하는 것이 좋다.
    #가짜 범위

  • 팀 규칙 - 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하길 바란다. 스타일은 일관적이고 매끄러워야 한다. 온갖 스타일을 뒤섞에 소스코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피한다.

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

  • 소스코드의 스타일을 내 맘대로 했었다는 것을 깨달았다.

  • 가로형식의 글자수를 200으로 놓고 했는데 120정도로 변경해야겠고, 팀이 사용하는 IDE를 맞춰서 사용해야겠다.

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

  • 연산자에 대한 공백에 같은 것들도 IDE를 맞춰줄 수 없을까?