코드 리뷰에 필요한 것들.

코드 리뷰는 개발자의 스킬 향상 뿐만 아니라, 개발 문화 형성에 아주 중요한 요소라고 생각한다. 그런 관점에서 코드 리뷰가 지속가능한 문화로 자리를 잡게하기 위해서 필요한 것들을 여기에 정리한다.

여기서는 코드리뷰에서 따라야할 기본 원칙들을 정리한다. 될 수 있으면 최소한의 원칙만 작성하는 것으로 한다.

구분	포인트	우선순위	코드 검토 기준	비고
사내 표준	안전성, 성능	MUST	테스트 작성	테스트 코드 가이드 참조
사내 표준	보안	MUST	비밀번호와 같은 민감한 정보를 로그에 남기지 않아야 함.	개발보안 가이드 참조
요구사항(기획)		MUST	기획에 맞게 개발이 이루어졌는지 여부	기획서 참조
공통	가독성, 유지 보수성	MUST	코드가 복잡성. 순환 복잡도 등 linter에서 오류가 있는 경우 수정	코딩 가이드 참조
언어 공통	가독성	MUST	매직 넘버를 쓰지 않아야 함	코딩 가이드 참조
언어 공통	가독성	MUST	네이밍 룰이 적절한지?
언어 공통	안전성	MUST	잘못된 값이 포함되지 않도록 유효성 검사
언어 공통	안전성	MUST	예외 처리가 빠진 곳이 없는지
언어 공통	안전성	MUST	적절한 오류 메시지인지?
언어 공통	유지 보수성	MUST	구현이 적절한 레이어에 구현되어 있는지?
언어 공통	성능	MUST	루프 내에서 DB를 처리하는 경우 대안 고민.	DB접속 횟수가 증가하고 성능이 저하됨

용어는 굳이 외우려하지 말며, 리뷰에서 넓은 관점을 유지하지 위해 정리한다. 리뷰에서 공식적으로 거론하지는 않으며 강요하지도 않는다.

DC(Duplicate Code) - 중복된 코드(중복된 코드나 조건들).
BPC(Bad Performance Code) - 성능에 좋지 않는 코드.
BN(Bad Name) - 변수나 클래스, 함수 등에 너무 길거나 가독성 떨어지고 일관되지 않은 이름.
VS(Violates Specifications) - 가이드나 지침을 따르지 않음.
TCL(Too Complicated/Larged) - 불필요하거나 너무 크고 복잡한 함수나 클래스.
LP(Long Parameter) - 불필요하거나 너무 긴 인자값들.
II(Inconsistent Indentation) - 비일관적인 들여쓰기.
NEC(Not Enough Test Cases) - 테스트 케이스가 너무 적음.
TMIS(Too Much If/Switch) - 조건 분기가 많음.
NC(No Comments) - 주석이 너무 없음.
SS(Shotgun Surgery) - 하나의 함수나 클래스를 변경했는데 많은 것들이 영향을 받는다.
FE(Feature Envy) - 다른 클래스의 속성과 메소드들을 사용해 다른 클래스와 강한 관계가 성립한다. 모듈(클래스) 독립적이지 못하다.
BC(Boilerplate Code) - Getter/Setter 등 맹복적으로 추가되는 반복적인 코드들.
TE(Throws Exception) - 예외 처리.
NG(Not General) - 너무 범용적이지 않음.
DD(Dead Code) - 사용되지 않거나 미리 만들어진, 불필요한 코드들.
MN(Magic Number) - 매직 넘버.
PD(Platform Dependency) - 플랫폼(언어, 환경 등) 종속성이 있다.
AOS(Abuse Open Source) - 오픈 소스 남용.

벨을 붙이면 액션을 명확하게 전달할 수 있고, 코멘크의 우선순위가 명확해져 효율성을 가져올 수 있다. GihubDocs >Setting >회신템플릿 만들기로 처리하면 외우지 않아도 된다.

Provide feedback