Community

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

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


TIL (Today I Learned)

2022.02.26

오늘 읽은 범위

5장. 형식 맞추기

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

  • 코딩 스타일을 맞추는 목적 (p. 96)

    • 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.

  • 변수 선언 (p. 101)

    • 변수는 사용하는 위치에 최대한 가까이 선언 (javascript의 경우 사용할 변수를 미리 상단에 정리해 둔 것들이 많던데 이 글과 어떤 상관관계가 있을까?)

  • 인스턴스 변수 (p. 102)

    • 인스턴스 변수는 클래스 맨 처음에 선언 (잘 알려진 위치에 변수를 모아두는것이 중요)

  • 종속함수 (p. 104)

    • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 자연스레 읽힌다.

      • C, C++, 파스칼 언어는 반대로 호출되는 함수를 먼저 정의해야 한다. (미리 선언해야 한다.)

  • 개념적 유사성 (p. 106)

    • 객념적인 친화도가 높은 코드는 서로 가까이 배치한다.

      • 함수 호출관계

      • 변수와 그 변수를 사용하는 함수관계

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

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

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

  • 이번 장은 개인이 주력으로 하는 언어의 코딩 스타일 가이드를 보면 충분 하라리 판단이 들었다. 그래서 따로 정리할 부분이 별로 없었다.

  • 의외로 나도 가로정렬을 하던 때가 있었다. 어디선가 그렇게 해야 보기 편하다고 해서...지금도 배열에 요소들을 넣을 때 사용중이다. 솔직히 보기가 훨씬 편해서 좋다. 이건 바꾸지 않을거 같다.

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