개발자들의 용어 정리 4 [코드리뷰, 문서화]

코드리뷰

일정 규모 이상의 프로젝트는 클라우드 문서 같은 곳에서 공유된 장소(Git hub, Docker etc..)에 소스코드를 올려두고

 

각자 파트에서 프로그래밍을 한다.

 

작성이 완료된 후 소스 코드를 적용하기 전에 동료 개발자들과 작성한 코드를 확인하고 의견을 주고 받는데

 

이를 코드 리뷰라고 한다.

 

 

장점은 다음과 같다.

ⓐ 작성자가 발견치 못한 오류를 타인이 발견하여 수정할 수 있다.

ⓑ 선임이 후임 개발자의 코드에서 미진한 부분을 짚어낼 수 있고, 선임개발자의 코드를 봄으로 인해서 실전 지식을 습득 가능

ⓒ "코딩컨벤션(변수의 이름을 짓는 법, 코드 줄을 맞추는 법 등 회사 내의 코딩스타일 규약)"을 지켜서 소스 코드에 대한 일관성을 지켜 가독성 및 스타일 공유로 빠르게 파악이 가능해진다.

 

 

문서화

개발자들은 가급적 코드를 가독성 있게 작성하고, 코드 중간에 설명을 달아서 다른 개발자 혹은 자신이 나중에 봤을 때 

 

이해하기 쉽게 글을 작성해 놓는 경향이 있다.(주석처리)

ㄴ 주석처리란? 소스코드에서 예외 처리 되는 문장으로 이 부분은 컴파일시 무시되므로 프로그램에 영향을 끼치지 않는 구문이다.

 

하지만 실무에선 워낙 소스코드가 방대하기 때문에 이와 같은 주석처리론 부족하다.

 

따라서 각 기능을 어떤 코드에서 어떻게 사용하면 되는지 등을 정리한 문서가 필요하다.

 

이는 앞으로 S/W를 사용할 사람들, 이를 수정, 개선하는 사람들을 위한 일종의 설명서다.

 

 

다소 시간이 걸리는 행위이지만 결과론적으로 S/W 품질 관리라는 측면에서 봤을 때

 

오류 발생시 작성한 코드의 분석 시간 단축, 시간적, 물적 비용 감소 등

 

문제 해결에 있어 걸리는 Loss를 최소화 하기 위해 반드시 필요한 작업이다.

 

 

어느정도 개발이 완료될 때마다 해당 코드, 설계에 대한 문서화는 반드시 업무 문화로 자리 잡도록 해야 한다.