코드 리뷰 체크리스트

Checklist for Developers

 

       코드가 컴파일 되었는가?

       개발자 테스트 및 유닛 테스트가 포함되었는가?

       Javadoc이 제 위치에 있는가?

       코드가 깔끔한가?(길이, 틀린 철차등)

       적절한 예외 처리를 고려하였나?       

       로깅을 적절하게 사용하도록 만들었나?

       사용하지 않는 import문은 제거하였나?

       이클립스의 경고들을 모두 처리하였는가?

       코딩 표준을 따르는가?

       코드에 불필요한 것이나 테스트 루틴들이 남아 있는가?

       하드코딩된 것이나 개발시에만 필요한 코드가 여전히 남아 있는가?

       성능에 대한 고려가 되었나?  

       보안에 대한 고려가 되었나?

       자원 해제에 관한 코드가 있는가

       문서화가 잘되어 있는지 아니면 프레임워크의 알려지 제한 사항에 대한 해결방법이 있는가?

       외부 재활용 컴포넌트 또는 라이브러리 함수들이 콜에 의해 바뀔 수 있는 코드가 있는가?

       Thread safety 한가? deadlocks가능성은 없는가?

       코드가 해야 할 일을 적절히 하고 있는가?

       내가 변경했을 때 현재 기능에 side effect를 줄만한 것은 없는가?

       코드가 현재 디자인/아키텍쳐와 일치하는가?

       새로운 것을 구현하기 전에 기존의 메소드 및 유틸들을 확인해 보았는가?

 

 

Checklist for Reviewers

 

       코드가 비즈니스 요구사항을 충족하는가

       주석이 이해할 수 있고 코드 유지보수를 위한 내용을 포함하는가?

       주석은 너무 많거나 장황하면 안된다.

       매개변수 타입이 적절하게 사용되었는가?

       예외가 적절하게 사용되었는가?

       반복적인 코드가 뽑아내어져 있는가?(별도의 메소드나 함수로..

       프레임워크가 적절하게 사용되었는가?

       Command 클래스가 단 하나의 작업을 수행하도록 설계되어 있는가?

       JSP가 비즈니스 로직을 포함하고 있지 않는가

       Unit test는 현재 코드 대상으로 작성되어있는가? 정확한가?

       흔히 있는 에러들이 확인되고 있는가?

       잠재적인 threding 이슈가 있을만한 곳은 제거되어있는가?

       모든 보안 문제가 해결되어 있는가?

       성능이 고려되어 있는가?

       이 기능은 현재 디자인과 아키텍쳐에 맞는가?

       코드가 단위 시험이 가능한가?

       이치에 맞지 않는 static method나 block을 사용하지 않는가?

       코딩 표준을 준수하는가?

       로깅을 적절히 사용하였는가?

       코드가 기존기능에 대한 side effect가 없는가?

       쓸데없이 시간을 낭비한 코드가 아닌가?(이미 있는 것을 확인하지 못하고..)