네이밍 컨벤션 - 집현전 프로젝트

세종대왕 프로젝트 (한글 코딩 컨벤션)

왔썹만의 한글 코딩 컨벤션

• 집현전 프로젝트를 하게 된 이유

  : 확실한 컨벤션을 정하여 일관되고 손쉬운 유지보수가 이번 프로젝트의 큰 목표 중 하나였다. 이전 팀 작업에서 일관되지 않은 네이밍 컨벤션으로 인한 유지보수의 시간 손실을 경험한 바 있기에 더욱 컨벤션의 일관성을 강조하게 되었다.

  영어를 사용할 때 비지니스 로직의 경우 개발자마다 사용하는 단어가 상이하다는 점과 영어에 익숙치 않은 개발자의 고민 시간을 단축할 수 있다는 점에서 한글 코딩 컨벤션이 적합한 컨벤션이라고 생각했다.

• 왓썹만의 한글 코딩 컨벤션

  • 기본 한글 컨벤션은 toss의 한글 코딩 컨벤션을 따른다.

  • 크게는 가장 많이 사용하는 비니지스 로직에 대한 식별자명을 정하고 이벤트 관련 함수의 식별자의 방향성을 통일

  • 예외적으로 한글 영문 혼재 가능 단어 : id

    • 이 부분에 있어 많은 고민과 상의가 필요했다. 혼재를 하지 않을 경우 ‘아이디’라고 사용할지 아님 ‘식별자번호’등과 같은 표현을 사용할지에 대한 고민이 있었는데, 오히려 이러한 부분은 지나치게 길어지거나 억지로 한글로 사용하는 느낌이 강하다는 이유로 예외적인 혼재 가능한 컨벤션으로 정하게 되었다.

    
    export interface 인터페이스_댓글_추가 {
      꿀조합id: string;
    }
    

  • 함수: ‘-하기’와 같은 동사 사용

    const 꿀조합_목록_필터링하기 = () => {
    	...
    }
    

  • props로 넘기는 부분은 영문으로 기재

• 어려웠던 점과 그에 따른 해결방안

  [어려웠던 점]

  • 사용하다 보니 어디까지 한글이 옳은지 고민
  • 각 팀원마다 개발시 생각하는 비지니스 로직의 기준이 상의했던 어려움
  • Firebase 사용시 한글 사용에 있어 통신에 어려운 부분이 있었고 이럴 때마다 정해놓은 컨벤션이 무너지지 않을까 하는 고민 속에서 균형을 잡는 것에 대한 어려움
  • 식별자명을 지을 때 한글과 외래어처럼 사용하는 단어들의 혼재된 부분에 대한 우리만의 컨벤션이 필요

  [해결방안]

  • 문제를 해결해 나간 단 한가지의 방법은 회의를 통해 각자 어떤 생각으로 비지니스 로직을 분류하였는지 살피고 맞춰나가며 범위를 좁힘
  • 기술이 지원하는 범위 내에서 가능한 컨벤션이 무너지지 않도록 노력

• 어떻게 조율해 나갔나

  • 컨벤션을 지키기 위해 주기적인 회의를 통해 통일 시키는 시간을 가졌다. 시간이 걸리더라도 다같이 코드를 살펴보고 조율하여 컨벤션에 따른 통일을 위해 노력했다. 시간이 갈수록 점차 정리되어 나갔고 한 사람이 만든 것 같은 식별자명을 가질 수 있게 되었다.

• 집현전 프로젝트를 하며 우리 팀원들이 느낀 점

  • 한글 컨벤션으로 했기 때문에 식별자명에 대해 더 집중할 수 있었다. 영어로 했었다면 습관적으로 지나칠 수 있었던 부분에 대해 다시 한 번 생각하게 되었고, 더욱 더 팀원의 코드에 더 집중할 수 있는 시간을 가질 수 있었다.
  • 쉽지 않았지만 일관적인 컨벤션을 맞춰 나가는 과정에서 꼭 한글 컨벤션이 아니더라도 정해진 컨벤션을 두고 작업 한다면 유지보수가 쉬워진다.