SI에서 '코드리뷰'하기 - 개요

코드리뷰를 시작한 이유

두 번째 회사로 이직한지 벌써 2년이 되었네요.

첫 번째 회사와 마찬가지로 SI 기업에 다니고 있는데요.

사업이 진행되는 중에 투입되어 지금은 유지보수를 하고있어요.

 

다들 아시죠?

사업 기간 내에 개발을 끝내고 운영해야 하는 것이 SI의 숙명인거...

그러다보니 많은 개발자들이 투입되었고, 기능을 하나씩 맡아 각자의 스타일대로 개발을 하였죠.

유지보수를 하다보면 정말... 기능별로 코딩 스타일이 달라요.

 

리스트에서 값을 꺼내는 반복문을 만들어도 누구는 전통적인 for문으로 개발하고, 누구는 향상된 for문으로 개발하죠.

또 누군가는 for-each문으로 개발하고요.

    // 이름을 저장하는 리스트 생성
    List<String> names = new ArrayList<String>();
    names.add("한국인");
    names.add("이순신");
    names.add("홍길동");

    // 개발자 A는 전통적인 반복문을 사용하여 값을 꺼냅니다.
    for(int i=0; i<names.size(); i++) {
        System.out.println(names.get(i));
    }

    // 개발자 B는 향상된 for문을 사용하여 값을 꺼냅니다.
    for(String name : names) {
        System.out.println(name);
    }

    // 개발자 C는 for-each문을 사용하여 값을 꺼냅니다.
    names.forEach(name -> {
        System.out.println("name : " + name);
    });

 

 

예제에서는 반복문을 통해 이름만 출력하기 때문에 유지보수할 때 어려움이 없죠.

하지만 반복문 안에 작성된 소스코드가 길고 복잡해지면 어떨까요?

당연히 유지보수가 어려워지지 않을까요?

 

유지보수를 조금 더 편하게 하기위해!

 

코드 리뷰를 통해 개선되어야 할 부분과 더 효율적으로 작성하는 방법을 서로 공유하면 분명 코딩 스타일도 어느정도 통일 될거에요!

(모든 개발자들이 100% 코딩 스타일을 통일시키는 것이 목표는 아닙니다!)

또한 효율적으로 작성하는 방법을 서로 공유하며 더 나은 개발자로 성장하는 계기가 될거에요.

많은 사람들이 'SI에서 무슨 코드 리뷰를 하냐'며 부정적으로 생각할 수도 있어요.

하지만 코드 리뷰를 아예 하지 않는 것보다 최소한의 활동을 하는 것이 분명 기업에도, 개발자에게도 도움이 될 것이라 생각해요.

마침 유지보수 기간이고 시간적 여유가 생겼으니 지금이 기회라고 생각하고 코드리뷰를 해보고 있답니다.

코드 리뷰의 목표

비록 코드 리뷰 활동 경험이 많지 않지만 그래도 목표하는 바가 있으니 코드 리뷰를 시작했겠죠?

제가 생각하는 코드 리뷰의 목표에요.

 

공통

1. 코드리뷰 문화 만들기
2. 서로의 코드를 살펴보면서 학습하기
3. 서로의 코드에 보며 더 좋은 개선 방법을 제안해보기
4. 오류 발생 가능성 줄이기

프론트엔드

1. const 사용하기
   • 변수 값을 바꿔야할 때만 let을 사용하기
2. 기능에 대한 설명을 주석으로 자세히 작성하기

백엔드

1. Java 소스코드 작성 시 들여쓰기 통일하기
2. MaBatis 쿼리 작성 시 들여쓰기 통일하기
3. 기능에 대한 설명을 주석으로 자세히 작성하기

아직은 코드 리뷰를 시작하는 단계이기 때문에 기본적인 목표만 세웠어요.

물론! 코드리뷰 문화 만들기라는 목표는 가장 큰 목표이자 궁극적인 목표에요!

아무리 바빠도 코드 리뷰를 꾸준히 하는 문화를 만들어 볼게요!