개발새발 로그

[TIL] 한 달간 코드리뷰를 하면서 본문

TIL

[TIL] 한 달간 코드리뷰를 하면서

이즈흐 2023. 11. 8. 16:59

한 달간 내가 코드리뷰를 하면서 또는 받으면서 문제점과 보완할 점을 정리하려고 한다.

 

 

첫 번째 과제

1. if ~ else문을 사용하지 않고, ealry return 하기
2. 변수명이나 함수명을 예측할 수 있게 작성하기
3. 고차함수 사용하기 (for...of 대신 forEach사용하기)
4. 함수는 카멜케이스 (postOrder)로 작성하기 - 파스칼 케이스(PostOrder)는 X

 

두 번째 과제

1. 에러를 발생시킬 때는 try..catch와 throw문 사용 - console.log로만 출력하지 말기
2. if ~ else 대신 a = b || [] 사용하기
3. 적절한 줄바꿈으로 가독성 있는 코드 작성하기
4. 관련있는 로직끼리 묶어서 가독성과 유지보수성 높이기 -> 함수로 바꿔주기

 

세 번째 과제

1. 정합성 체크시 오류도 출력해주기 - 정합성 체크 + 에러 메세지
2. 파일명과 함수명을 동일하게 작성하기
3. 함수명은 동사 + 명사 조합으로 선언하기
4. 불필요한 ealy return 사용하지 않기
5. console.log() 지워주기
6. 핸들러 이벤트와 같은 경우는 함수로 분리해주기
7. 중복된 URL은 분리해서 상수로 작성하기
8. 정합성 체크시 객체의 key값 뿐만 아니라 type도 체크하기
9. 사용하지 않는 import 제거해주기

 

노션프로젝트

1. 파일을 종류별로 폴더에 넣어주기 - 파일구조를 설계하기
2. JSDoc로 입력과 출력을 문서화하기
3. 컴포넌트 마다 기능을 너무 길게하지 말기 - 변수 상수가 많은 것
4. api를 호출하는 부분을 따로 함수로 만들어주기 -> 코드리뷰할 때 굳이 안봐도 되는 내용은 함수로
5. inlineStyle과 css 파일의 style을 한번에 모아주기 -> 둘 중 하나만 통합해서 하기
6. 상수는 변수로 만들어서 표현하기
7. PR에는 많은 도식과 내용이 불필요하다.
8. CSS파일도 기능별로 나누기 - 기준을 정해서 분리해주기
9. 중요한 key값들은 gitignore로 따로 설정해주기
10. innerHTML과 appendChild의 사용할 상황에 대해서 구분하기
11. 함수로 분리해서 가독성 높이기
728x90
반응형
LIST