<aside> 💡

목차

</aside>

1. 좋은 코드를 짜도록 하자.

우리팀의 좋은 코드는 아래와 같은 코드로 정의한다.

a. 읽기 쉬운 코드 - 코드를 읽기 쉽도록 해야 협업에서 기술적 동기화 작업과 더 나은 작업을 위한 이해를 할 수 있다.

b. 중복이 없는 코드 - 똑같은 코드의 반복은 쓰레기다. 기능에 대해 함수로 분리하여 구현하고, 조합함으로써 깔끔한 코드를 지향하자.

c. 테스트가 쉬운 코드 - 테스트 코드의 이점은 크게 두 가지가 있다. 실제 동작함을 증명하며, 기능의 이해를 돕는다.

테스트 코드를 적음으로써 최고의 효율을 취하기 위해서는 점진적인 개선이 가능하도록 테스트 코드가 지지해주는 것이다.


2. 부채는 꼭 상환의 의무를 지자.

버그에 대한 응급처치를 취할 수 있다. 깨끗한 코드를 뒤로하고 기능 구현에 집중했을 수도 있다. 당장에 깔끔하게 구현하지 못해 임의로 동작하도록 구현할 수도 있다. 이러한 행위들에 대해서 '부채'라고 우리는 명명하며 이를 꼭 상환하는 의무를 지도록 한다. 잠시 기술 부채를 두고 문제를 해결하는 것도 중요하다. 그러나 부채가 많아질수록 유지보수에 더 큰 비용이 드는 위험을 방지하기 위해 제 때에 갚도록 하자.


3. 일관성 있게 작성하자.

우리는 구글 자바 컨벤션에 따라 코드를 작성한다. 이에 따라, 명명화와 코드 스타일이 일관성을 지켜야 한다. 만약 컨벤션에 들어맞지 않는 코드를 발견한다면, 리뷰 시 최대한 잡아주도록 모든 팀원이 노력해준다.


4. 객체를 객체답게, 객체지향 체조원칙을 준수한다.

우리는 자바 언어 기반의 스프링 프레임워크를 통해 코드를 구현한다. 스프링을 스프링답게 사용하기 위해서는 객체 지향적으로 사용해야 하며, 변화와 확장에 열려있어야 한다. 당장에 객체지향을 제대로 지키고 있는가에 대한 확신이 없을 수 있다. 이를 우리는 객체지향 체조원칙에 들어맞게 작성함으로써 불안감에서 벗어나, 더 나은 코드로 개선해나가도록 코드리뷰에 힘쓴다.