코드 리뷰를 할 때 보아야 할 것
1) 설계
사내 애플리케이션 설계 원칙과 일반적인 프로그래밍 설계 지침에 맞춰서 코드가 작성되어 있는지 확인합니다.
2) 비즈니스 로직을 몰라도 리뷰를 할 수 있는 사항들
유지보수성
- 중요한 값을 하드 코딩을 하고 있지는 않은가요?
- 주석이 코드가 하는 일이 아닌, 코드에 담긴 의도를 설명하고 있나요?
- 코드를 쉽게 이해할 수 있나요?
- 설정이 용이한가요? 코드의 특정 부분을 설정 파일(.env)파일을 사용해서 설정을 변경하게 만들 수 있는지 확인합니다.
- 스타일 가이드에 맞게 작성되어 있나요?
- 하나의 함수가 10 라인을 넘어간다면 너무 많은 관심사를 갖고 있는 건 아닌지 유심히 봐주세요.
재사용성
- 중복된 코드는 없나요?
- 두 번 이상 반복해서 등장하는 코드는 함수나 클래스로 분리하는 걸 검토하세요.
안정성
- 예외 처리를 제대로 하고 있나요?
- 자원을 효율적으로 반환하고 있나요? 예) useEffect의 clean up function에서 제대로 초기화를 했는지
확장성
- 새로운 기능을 추가하기 쉽게 작성되어 있나요?
- 함수나 클래스가 두 개 이상의 관심사를 갖고 있지는 않은지 확인해주세요.
테스트
- 모든 코드는 테스트 하기가 쉬워야 합니다.
- 테스트가 작성되어 있는지 반드시 확인을 합니다.
- 테스트가 작성되어 있다면 테스트 작성 가이드를 참고해서 개선할 부분이 있는지를 확인합니다.
참고 :
'개발 > 개발 트랜드' 카테고리의 다른 글
| 함수형 프로그래밍(Functional Programming) (0) | 2023.04.04 |
|---|---|
| [TDD] 단위 테스트(Unit Test) (0) | 2023.03.08 |
