데일리 잡(Job) 지식

클린코드 작성 1원칙, 데드 코드(사용하지않는 코드)청소하기

개발하는 주디씨 2023. 10. 27. 13:57

 

클린코드 작성하고 싶다..
어떤 것부터 시작해야할까?

 

 

실행되지 않는 코드는 모두 삭제하는 것이 정리의 시작입니다. 프로젝트를 새로 만들면 생겨나는 여러 함수와 주석들을 삭제하는 습관을 들이면 좋습니다. 개발자의 시간, 노력, 눈물이 들어간 코드와 조직의 비용이 지불된 가치를 삭제하는 것이 아깝게 느껴질 수 있지만, 이런 사용하지 않는 코드가 프로젝트에 존재하는 것만으로 발생하는 비용의 문제가 있으므로 꼭 삭제하는 습관을 들여야 합니다. 실제로 코드리뷰에서 이 지점에서 발생하는 비용이 적지 않습니다.

 

구글 코드리뷰 가이드라인에서는 CL의 모든 줄을 리뷰해야 하는 것을 원칙으로 삼고 있습니다. 물로 코드의 중요도에 따라 훑어만 봐도 괜찮은 코드와 주의 깊게 살펴야 하는 코드는 나뉘겠지만, 기본적으로 모든 줄을 리뷰해야 한다는 점에서 실행되지 않는 코드가 존재하는 것은 많은 시간과 비용을 낭비할 수 있다는 점을 알아야 합니다.

 

“하지만 나중에 필요하면 어쩌지?” 이것이 바로 버전 관리의 가역성의 원리를 기억해야 합니다. 되돌리기 쉬운 코드는 구조와 행동의 변경에만 존재하는 것이 아닙니다.

 

1️⃣지금 당장 사용하지 않는 코드가 많지만

2️⃣ 나중에 또 사용할 것 같은 느낌이 들고

3️⃣ 크게 수정하지 않고도 사용할 수 있을 것 같고

4️⃣ 약간만 수정하면 더 나은 코드가 된다는 생각이 들지만

 

객체의 상태 하나의 변경이든, 폴더의 변경이든 되돌리기 쉬운 선택을 위해 늘 버전 관리에 신경을 쓰는 것이 좋습니다.

클린 코드를 작성하고 싶다면, 우선 실행하지 않는 코드와 왜 존재하는지 알 수 없는 주석은 과감하게 삭제합시다!!