코드 리뷰 -1-

2022. 03. 25(금). 회사에서 코드리뷰를 진행했다.

현재 진행중인 프로젝트의 Flutter로 작성된 앱 개발 소스코드를 보며 진행하였다.

 

두시간 가량동안 진행되었던 코드 리뷰에서 피드백 받은 사항들을 정리해 보았다.

---

 

1. 확장성이 좋은 코드를 짜자. 

좋은 코드란 무엇일까? 가독성이 좋고, 유지보수가 용이해야한다.

이 코드를 베이스로 비즈니스의 요구에 맞도록 시스템을 확장하기에 용이한 코드를 작성해야 한다.

 

 

2. 언어의 특징을 파악하자.

가령 Javascript를 쓴다면, 왜 Function Base로 작성하였는지, Class Base를 선택하지 않은 이유는 무엇인지 와 같은 이유를 알고 있어야 한다. 이에대해 근거가 없다면 모르는 것일 뿐이고, 그 프로그래밍의 언어에 대해 제대로 알고 짠게 아니라는 뜻이 된다.

 

3. 기타 사항

• 프로젝트 디렉터리 관리에 신경을 쓰자.
  • 같은 레벨의 폴더들은 분류한 기준의 일관성이 있어야 한다.
    • 가령 한 폴더 내에 기능으로 분류한 폴더가 있고, UI로 분류한 폴더가 있다면, 이 구조를 처음 본 사람은 단숨에 파악하는데에 어려울 수밖에 없을 것이다.
• 소스를 수정하는곳이 적게 만들자. (공통으로 사용되는 코드를 관리)
  • REST API 호출 Body를 만드는 것은 클래스나 함수화 하는것이 좋다. (개인적 의견)
    • 같은 API를 호출하는 곳이 여러곳이라면, 그 곳마다 Body 데이터들을 만들어 주어야 한다. 하지만 그 Body를 만들어주는 클래스나 Function이 있다면, 파라미터를 받던지 해서 만들어 리턴해주기도 하고, 한곳에서 관리하기때문에 코드를 관리하기에 수월하다.
  • 사이즈, 타입과 같은 공통으로 사용하는 값들은 상수로 관리하여 사용하는 곳에서 참조할수 있게 하자.
• 에러코드와 같은 것 상태코드들은 무조건 숫자로, 문자는 지양하자
  • 다국어 시대에서 상태코드를 문자로 사용한다는것은, 이미 다국어 지원은 물건너 간다는 뜻이다. 숫자를 사용한다는 것은 만국 공통의 의미를 관리한다는 뜻도 되며, 여러 언어에 맞게 변환할 수가 있다.