읽기 쉬운 코드로 기술 부채를 막을 수 있다

간판하다(가칭)를 개발하는 중에 추후 웹 서비스 진행시 필요할 것이라 판단해 Django 책을 사서 학습하고 있다. 현재 간판하다는 자바스크립트와 제이쿼리를 이용해 만든 데이터를 업로드 하는 웹 폼과 고객이 사용할 안드로이드 앱을 메인으로 삼고 있다. 나중에는 웹 앱도 개발 해야 할 텐데 Django를 이용하는 것이 좋을 것 같아서 선학습 중이다.

프로그래밍 인사이트에서 낸 'Two Scoops of Django'는 내가 정말 사랑하는 노란색 표지가 인상적인 책이다. 이제 거의 처음 부분을 읽고 있는데 '코딩 스타일'에 대해 이야기 하는 부분이 인상적이라 나의 코딩 지침으로 삼기 위해 기록해둔다.

Two Scoops of Django 국내도서 저자 : 대니얼 로이 그린펠드(Daniel Roy Greenfeld),오드리 로이 그린펠드(Audrey Roy Greenfeld) / 김승진역 출판 : 인사이트 2016.08.12 상세보기

읽기 쉬운 코드의 장점

1. 나중에 코드를 읽을 때 개발자의 뇌가 덜 피곤하다.

2. 유지 관리가 쉬워진다.

3. 프로젝트 개선 작업이 수월해진다.

읽기 쉬운 코드를 만들기 위한 지침

1. 축약적이거나 함축적인 변수명은 피한다. (bal_s 보다는 balance_sheet 처럼 확실하게)

2. 함수 인자 이름은 꼭 써준다.

3. 클래스와 메서드를 문서화 한다.

4. 코드에 주석은 꼭 단다.

5. 재사용 가능한 메서드 안에서 반복되는 코드들은 리팩토링 해둔다.

6. 메서드는 가능한 한 작은 크기를 유지한다. (스크롤 없이 읽을 수 있는 길이가 적합하다)

위의 지침중 특히 변수명을 짧게 줄여서 사용하는 것은 코딩 당시에는 타이핑 시간을 줄이는 혜택을 볼 수는 있겠지만, 나중에 다시 코드를 볼 때 해석을 위해 시간을 많이 허비하게 되는 요인이 된다. 이런 기술적 부채를 줄일 수 있다면 처음에 귀찮더라도 '읽기 쉬운 코드 지침'을 지키는 것이 더 낫다.