산 넘어 산 개발일지

Clean Code - 형식 맞추기 본문

Study/CleanCode

Clean Code - 형식 맞추기

Mountain96 2021. 2. 19. 13:27

코드에도 지켜야 할 형식이 있다.

형식은 어떻게 하면 타인이 보기에 이해하기 쉬울지에 대한 고민에서 시작된다.

아마 클린 코드에 대한 모든 시작점이 이 고민일 것이다.

클린 코드에서의 형식은 보통 위에서 아래로 읽을 때 고차원 -> 저차원 으로 흘러가고, 비슷한 개념을 공유하는 부분끼리는 최대한 붙어 있다.


내 코드 돌아보기

1. 세로 밀집도

  • onCreateView()라는 함수가 두 함수를 호출하여 사용하는데, 호출하는 함수 다음에 호출을 당하는 함수들이 차례대로 배치가 되어서 쉽게 읽힌다. (종속 함수)

2. 고차원 -> 저차원

  • 밑으로 갈 수록 저차원 함수를 정의하여 세부 동작을 정의했지만 맨 위에서 좀 더 고차원적인 추상화로 설명을 넣어줬으면 좋았을 것 같다.
  • 이 클래스가 어떤 클래스인지 알기 위해서는 코드를 다 읽어봐야 하므로, 클래스 위에 주석으로 어떤 알고리즘을 사용하고 어떤 개념의 클래스인지를 명시하는 것이 좋을 것 같다.

기억할 포인트

  • 세로 밀집도 : 종속 함수, 추상화 단계가 비슷한 함수는 최대한 붙여서!
  • 고차원 추상화 : 맨 위에 사용한 개념, 알고리즘 명시(특히 코드가 길 수록 더더더 필요!)

'Study > CleanCode' 카테고리의 다른 글

Clean Code - 클래스  (0) 2021.03.04
Clean Code - 단위 테스트  (0) 2021.03.03
Clean Code - 경계  (0) 2021.03.01
Clean Code - 객체와 자료구조  (0) 2021.02.21
Clean Code - 함수  (0) 2021.02.09
Comments