Community

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

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

오늘 TIL 3줄 요약

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

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

  • 팀은 한가지 규칙에 합의해야 하고, 모든 팀원은 그 규칙을 따라야 한다.

TIL (Today I Learned) 날짜

2022. 05. 02

오늘 읽은 범위

5장. 형식 맞추기

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

  • 형식을 맞추는 목적은 의사소통을 잘하기 위함이다.

  • 맨 처음 잡아놓은 구현스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.

  • 먼저 적당한 행 길이를 유지하라(200줄 미만)

  • 개념은 빈 행으로 분리하라(패키지 선언부, import문, 각 함수 사이에는 빈 행이 들어간다)

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

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

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

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

  • 코드 길이는 20~60자가 적당. 120자 정도로 행 길이를 제한한다.

  • 들여쓰기를 잘 하자

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

  • 주로 파이썬으로 코드를 짜는데, 파이썬도 PEP8이라는 스타일 가이드가 존재한다. 개발을 공부할 때는 PEP8을 꼭 지켜야 하나, 뭔가 조건이 많다, 어려운 느낌이라 크게 와닿지 않았는데, 팀 프로젝트를 하면서, 구직활동을 할 때 회사의 기술과제를 하면서 PEP8의 중요성을 깨닿게 되었다. 과제의 조건 중 PEP8을 따르거나, 따르면 가산점을 주는 회사도 있었다. 이런 회사 같은 경우는 내부 컨벤션이 어느 정도 잘 자리잡고 있겠다라는 생각이 들었다.

  • 어느 정도 일관된 형식을 가지고 있어야 다른 사람의 코드를 이해하기도 쉽고, 가독성이 높아지는것을 겪고 그 후로는 내부적인 규칙이나, 세세하게 규칙이 없는 부분의 PEP8을 따르려고 노력중이다. 아무래도 지금 다니는 회사가 초기 스타트업이라 이런 부분이 엄격하지는 않지만 조금씩 컨벤션을 정해나가고 있는 중이고, 규칙으로 정할 만한 부분은 제안도 하고 있다.