Community

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

← Go back
TIL. #8 형식 맞추기
#clean_code
2년 전
444


TIL (Today I Learned)

2022.01.28

오늘 읽은 범위

5장. 형식 맞추기

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

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

오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.

 

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

    • 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

    • 신문 기사처럼 작성하라

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

      • 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명. 아래로  내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

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

      • 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다.

    • 세로 밀집도

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

    • 수직 거리

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

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

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

      • 개념적 유사성: 친화도가 높을수록 코드를 가까이 배치한다.

  • 가로 형식 맞추기

    • 짧은 행이 바람직하다.

    • 개인적으로는 120자 정도로 행 길이를 제한한다.

    • 가로 공백과 밀집도

      • 공백을 사용해 밀접한 개념과 느스한 개념을 표현한다.

    • 가로 정렬

    • 들여쓰기

      • 범위(scope)로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.

      • 간단한 if문, 짧은 while문, 짧은 함수에서 들여쓰기 규칙을 무시하고픈 유혹이 생기지만 들여쓰기를 넣는다.

    • 가짜 범위

      • 빈 while문의 세미콜론은 새 행에다 제대로 들여써서 넣어준다.

  • 팀 규칙

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

지역 변수나 메소드 선언 위치에 대해 평소에 고민했던 내용들이 나와서 신기했다.

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