[241115 TIL] 본캠프 33일차 ('뉴스피드' 프로젝트 1일차)

Clean Code란?

코드도 결국엔 글이고 메시지이므로 계속해서 코드를 읽기 쉬운 방향으로 변경하도록 노력해야 한다. 그렇기 때문에 단순히 동작하게만 작성하는 것이 아니라 남이 봐도 이해할 수 있도록 작성하는 것이 중요하다.

 

즉, 의도를 잘 담고 있고 그 의도를 다른 사람이 최소한의 노력으로 이해하고 납득할 수 있는 코드가 Clean Code일 것이다.

 

 

Clean Code를 위한 가이드라인

의미있는 변수명 짓기

• camelCase : 변수 및 함수
• kebab-case : 페이지, pathname, 폴더, css의 className
• snake_case : 상수 (주로 대문자로 생성)
• PascalCase : 컴포넌트 및 페이지 파일

 

구조 분해 할당 및 스프레드 연산자 적절히 사용하기

 

명확한 조건 선택하기

• 긍정 조건 사용하기
• 조건이 길어질 경우 변수나 함수로 분리하기
• 조건문의 성능은 생각하지 말기
• 조건 및 반복문의 깊이가 너무 깊어지지 않게 하기

 

코드 퀄리티 및 가독성 올리기

• 하나의 함수는 한 가지 일만 하도록 하기
• Custom Hook 사용하기
• 파일을 분리하고 이름을 명확하게 짓기

 

 

PR 리뷰를 하는 이유

 코드 리뷰는 팀원의 코드를 깎아 내리는 것이 아니다. 모르는 부분은 질문하고, 마음에 드는 부분은 칭찬하고, 마음에 안드는 부분은 개선점은 제안하거나 논의를 해보는 긍정적인 커뮤니케이션이다.

 

좋은 리뷰

• 이 부분은 코드 응집도가 낮아 보이는데 더 높게 만들 수 있는 방법이 있을까요?
• 제가 이 부분을 이해하지 못했는데 설명해 주실수 있나요?
• 이 부분은 ~ 한 것 같은데 ~ 한 것이 더 좋을 것 같아요. 어떻게 생각하시나요?
• LGTM! (Look Good To Me!)
• 이 부분은 저희 컨벤션에 어긋나는거 같은데 수정해주실 수 있나요?

 

나쁜 리뷰

• 무지성 비난, 대안없는 비판, 불만만 늘어놓는 리뷰
• 여기 이렇게 하시면 어떡해요?
• (무관심)
• 그냥 마음에 안 드는데 다시 해오시면 안되나요?

 

좋은 PR 리뷰를 위한 가이드라인

• 작은 단위로 PR 작성하기
• 작은 단위의 의미 있는 commit 작성하기
• 라벨 활용하기