클린코드 Day 11. 형식 맞추기

✅ 이 포스팅은 노마드 코더 북클럽  '클린 코드' 챌린지를 진행하면서 작성하는 TIL이며,  출처는 Clean Code입니다.

 

📚 범위 :  ~05. 형식 맞추기

 

 

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

• 코드 형식 === 의사소통
• 좋은 형식으로 작성하는 방법
  • 새 개념을 시작할 때는 빈 행 넣기
  • 밀접한 내용은 가까이 (세로 거리가 가깝게 작성)
    • instance 변수 ⇒ class 맨 처음에 선언
    • a 함수가 b 함수를 호출한다면 둘을 가깝게, 되도록 a를 b보다 먼저 작성
    • 개념 친화도 ⬆ ⇒ 가까이! (종속 함수, 변수 - 변수 사용 함수, 비슷한 동작 수행)
  • 들여 쓰기 잘하기 
  • Team이 있다면 Team 규칙 정하고 그에 따르기, 개인행동하지 않기
  • 다른 사람이 읽기 쉽게, 규격화해서 작성 (재 사용성⬆)

 

 

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

코드는 기계와 사람 간의 소통이라고 생각했었는데, 책을 읽을수록 사람과 사람과의 소통에서 더 중요한 역할을 한다는 것을 알게 되었다. 또한 좋은 소프트웨어를 만들기 위해서는 읽기 쉬운 코드로 작성해야 하고, 유지 보수가 용이할 수 있도록 형식을 지켜서 코드를 작성해야 한다는 점을 배웠다. 그리고 항상 IDE에 formatting을 즐겨 썼는데, 시스템에만 의존하는 것이 아니라 들여 쓰기, 비슷한 개념의 세로 위치를 가까이 작성하기 등을 유의하면서 코드를 작성해야겠다.

그리고 지난번에 만든 토이 프로젝트의 코드들을 다시 살펴보면서 오늘 배운 내용을 바탕으로 일관성 있게 다시 고쳐봐야겠다.

 

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

팀에서 사용하는 방식은 어떤 것들이 있는지 궁금하다. ESlint를 사용하지 않고 하는 것인지 사용한 후 다시 수정해 주는 것인지 궁금하다. 그리고 JS에서는 개념을 먼저 작성한 후 더 아래에서 호출을 해야 한다고 생각했는데, 예시 코드를 보니 개념이 아래에 있고, 호출하는 코드가 더 상단에 위치하는 거 같아서 조금 더 공부를 해봐야겠다!

좋은 예:

    class PerformanceReview {
      constructor(employee) {
        this.employee = employee;
      }

      perfReview() {
        this.getPeerReviews();
        this.getManagerReview();
        this.getSelfReview();
      }

      getPeerReviews() {
        const peers = this.lookupPeers();
        // ...
      }

      lookupPeers() {
        return db.lookup(this.employee, 'peers');
      }

      getManagerReview() {
        const manager = this.lookupManager();
      }

      lookupManager() {
        return db.lookup(this.employee, 'manager');
      }

      getSelfReview() {
        // ...
      }
    }

    const review = new PerformanceReview(employee);
    review.perfReview();

출처 : 클린 코드 - 자바스크립트 ko 버전 깃허브