노개북(노마드코더 Challenges)-클린코드 DAY6

mingki·2022년 5월 2일
0

5장.형식맞추기

❤️ 형식을 맞추는 목적과 방법

  • 목적 : 코드 형식은 의사소통의 일환이다 또한 코드 형식을 잘 잡아두면 오랜시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아 놓은 구현 스타일과 가독성 수준은 유지보수 와 확장성에 용이하다
  • 방법1) 신문 기사처럼 작성하라 : 소스파일도 신문 기사와 비슷하게 작성하는것이 좋다, 이름은 간단하면서도 설명이 가능하게 짓는다. 이름만 보고도 모듈을 살펴보고 있는지 아닌지를 판달할 정도로 신경써서 짓는다 그리고 소스파일의 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사하고, 마지막에는 가장 저차원 함수와 세부 내역이 나온다
  • 방법2) 개념은 빈 행으로 분리하라 : 하나의 메서드가 끝났다면 한줄의 빈행을 넣고 다음 메서드를 작성하면 가독성이 좋아진다
  • 방법3) 세로 밀집도 : 세로 밀집도는 연관성을 의미한다. 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다
  • 방법4) 수직거리 : 변수는 사용하는 위치에 최대한 가까이 선언한다. 지역 변수는 각 함수 맨 처음에 선언한다. 인스턴스 변수는 클래스 맨 처음에 선언한다. 한 함수가 다른 함수를 호출하는 종속 함수의 경우 세로로 가까이 배치한다 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다 그러면 프로그램이 자연스럽게 읽히며 호출되는 함수를 찾기쉬워지고 모듈 전체의 가독성도 높아진다
  • 방법5) 개념적 유사성 : 친화도가 높을수록 코드를 가까이 배치한다
  • 방법6) 팀 규칙 : 팀은 한 가지 규칙을 합의해야 한다 개개인이 따로국밥처럼 맘대로 짜는 코드는 피애햐 한다
    ★ 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하고 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤는 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야한다

‼️ 나의생각

1~4장 까지는 내가 잘못짠 코드에 대한 반성만 했는데 이번장은 코드를 작성할때 내가 그나마 잘 지치고 있는 부분을 이야기 하고있어 기분이 좋았다. 조금 부족한 부분은 책에서 이야기하고 있는 부분을 참고해 보완해 나가면 더 좋을것 같다

profile
비전공초보개발자

0개의 댓글