세리프 따라잡기

WEEK05 - TIL 코드리뷰 강의 간단 정리 본문

SW사관학교 정글

WEEK05 - TIL 코드리뷰 강의 간단 정리

맑은 고딕 2022. 5. 5. 11:02

류석영 교수님의 코드리뷰 강의 간단 정리 [중요하다고 생각하는 부분만!]

 

1. 코드 리뷰가 필요한 이유
- 다른 사람이 읽기 쉽게 코드를 개선할 수 있다.
- 리뷰어가 남긴 의견으로부터 배울 수 있다.
- 결함을 줄일 수 있다.
- coding decision에 대한 개발 역사를 보관할 수 있다. 새로 들어온 사람이 커밋을 보고 이해할 수 있게 된다.
- 일관적인 코딩 스타일을 유지할 수 있게 되면서 refactoring과 debugging에 큰 도움이 된다.
- 협력심을 기를 수 있다.

∴ 제일 좋은 코드 리뷰 "이 코드는 ~한 이유로 ~하게 바꾸는 게 좋습니다." + 참고한 링크

2. 코드 리뷰의 단점
- 거칠고 무례한 의견으로 인해 의지를 떨어뜨릴 수 있다.
- 리뷰가 늦어지면 개발 기간이 늦춰진다.
- 코드 리뷰를 제대로 하려면 시간이 오래 걸린다.
- 경험이 부족한 개발자의 코드를 리뷰하느라 숙련된 개발자의 시간이 낭비될 수 있다.
- 코드 리뷰를 위해서는 어느 정도 숙련된 개발자가 필요하다.

3. 가이드라인
- 코드 리뷰는 작성하는 사람을 위한 것이 아니라, 읽는 사람을 위한 것이다.
    ex. 타입을 선언 안하는 등, 편하다고 생각하는 것을 익숙하게 쓰다보면 스노우볼로 큰 구멍이 생길 수 있다.

        디버깅이 오래 걸릴 수 있다.
- 타입(const, let 등)도 그냥 쓰고 변수도 짧은 것이 아니라 길게 써서 읽으면 무슨 변수인지 알 수 있도록 한다.
- (변수나 함수 등) 네이밍을 할 때 약자 사용을 지양한다.

 

굿!!~ 🙇‍♀️

Comments