개발자분들께 코딩 스타일 질문 드립니다

  • #3247863
    하하하 128.***.214.50 1895

    초년생 개발자입니다
    회사에 개발자가 별로 없는 비 IT 계열의 회사인데
    직원 각자가 각자 프로젝트를 맞아서 하다보니, 한사람이 공석이면 다른사람이 그 프로젝트를 맡아서 하기에 시간이 걸립니다

    이번에 회의를 하면서
    코딩 스타일에 대한 표준화를 시켜보자고 하려고 하는데

    물론 자율적으로 코딩하는게 좋기야 하겠지만
    제가 쓰는 코드를 (제가 못해서 그럴수도 있지만) 다른 동료들이 보기 힘들어하고
    저도 다른 동료들의 코드를 이해하기가 조금은 어렵더라구요

    여기 대기업 다니시는분들 많이 계시는 것 같은데
    혹시 사내에서 쓰는 코딩 스타일 규약(?) 같은게 있나요

    아니면, 참고할만한 좋은 자료가 있다면 추천 부탁드립니다 (온라인 말고도 책도 괜찮아요)

    팀의 발전 뿐만 아니라, 저도 좀 발전하는 계기가 되었으면 합니다
    감사드립니다

    추가: 언어를 안썼네요. C#, VB를 주로 사용하고, .Net framework로 VB를, C#으로 ASP.NET Core 를 사용하려 합니다.
    Javascript랑 MS SQL, XML을 자주 사용하고, Angular를 쓸 계획이라 Typescript도 쓰겠네요.

    • ㅁㄴㅇㄹ 167.***.24.26

      구글이나 Airbnb같은 회사에서 공개한 코딩 스타일 가이드라인 있어요. 언어가 같다면 한번 참고해보세요.

      Code Complete 2 책도 한번 참고해보세요

      • 하하하 128.***.214.50

        답변 감사합니다. Airbnb는 github에 javascript만 올라와있는데, 이것말고 또 있나요? 구글도 깃허브고…
        책도 검색해서 한번 찾아보겠습니다.

    • ㅇㅇㅇㅇ 68.***.135.150

      .met 환경이시면 Abstract 나 interface 쓰시던가 최소한 버츄얼 써서 자식클래스에서 구현시키시던가

      • 하하하 128.***.214.50

        그렇게 하겠습니다. 감사합니다.

    • k4 100.***.113.197

      그건 sonarqube가 de facto 표준입니다. 이거 어떻게 쓰는건지 연구해서 갖다 쓰세요.
      https://docs.sonarqube.org/display/PLUG/Plugin+Library
      미니멀하게 각 개발자별로 쓰려면 mvn, sonarqube 두 개 조합을 쓰면 되고, 자동화해서 daily 로 체크하고 싶으면 중간에 jenkins를 넣어서 mvn, jenkins, sonarqube 를 쓰면 됨.

      • k4 100.***.113.197

        language를 거지같이 구사하는 경우들은 위의 sonarqube가 아주 혼쭐을 내주니까 그걸로 해결보시면 되고.

        새 개발자가 와서 로직을 즉시 이해하지 못하는 경우는 use case 문서화가 잘 안 되어 있으면 그렇습니다. use case는 business feature 고수준에서 utility method 같은 아주 작은 단위까지 정의할 수 있는데, 보통은 문서를 만들지 않고 말로 협의하고 코딩해서 커밋하고 땡 치죠. 이건 개발자들의 오랜 dna 입니다, 아무리 강조해도 결국은 다 말로 하고 문서는 안 남고 남기더라도 차후 갱신하지 않아 문서가 죽습니다. 그래서 다음 개발자 교육을 위한 문서화 강조 및 시행은 정답이 아닙니다.

        이 use case 문서화는 unit test를 통해서 하시는 게 효과적입니다 (이 싯점에서 TDD 검색). unit test는 두 가지 목적으로 사용하는데 첫번째는 코드 변경 때마다 주요 happy case와 negative case들이 여전히 잘 작동하고 있다는 것을 확인하기 위해서 쓰고 (regression test라 부릅니다), 두번째는 코드가 얼마나 잘 테스트 되었는지를 측정하기 위해서 씁니다 (line coverage test라 부릅니다).

        그래서 팀에 두 가지 규칙을 더 도입하면 개발자 간 use case 교육의 문제들도 거의 해결됩니다. 1) 코드 커밋 시 모든 작성된 unit tests가 성공할 것. 2) unit tests를 돌릴 경우 line coverage 80% 이상으로 만들 것.

        내가 있던 예전 팀의 경우 java, javascript 둘 다 80% 안 되면 integration server로 모듈 deploy가 안 되도록 system rule을 걸어 놓았음. 처음에는 80% 너무 높다고 생각했는데 쪼니까 다 됨. 새 개발자가 와도 본래 개발자한테 묻지 않고도 unit test 죽 돌려보면 주요 기능 파악이 하루 이내에 다 끝남.

        처음에는 line coverage 30% 정도를 목표로 해서 로직의 entry point를 전부 커버하는 정도로 하면 regression test 및 유사시 다른 개발자 교육용으로 충분할테고, 이 과정이 익숙해지면 점차 목표 %를 올려서 exception 같은 것까지 테스트 하는 negative case를 계속 추가해서 80%를 향해서 가면 됨.

        • 하하하 128.***.214.50

          답변 감사합니다.
          mvn을 검색하니 maven이라고 뜨는데, 맞는지요?
          말씀해주신 것들을 한번 보고, 팀원들에게 제안 해 봐야겠습니다.
          경험에서 온 정성어린 답변 정말 감사드립니다. 정말 많이 도움 되었습니다.

    • Scrum 98.***.190.131

      Scrum master를 노련한 senior developer 뽑고 한 일주일간 코딩 스타일 규격 통일하세요. 너무 detail한 것까지 통일하면 자유도가 낮아지니 개괄적인 것을 중심으로요. 이를테면 design pattern을 MVVM으로 한다던지하는. 그 이후에 Bitbucket상 commit – peer review – product owner review – merge순으로 가고 contiguous integration을 jenkins로 돌리면 어느 정도 체계가 잡힙니다. Biweekly로 retrospective하면서 지속적으로 coding standard잡아가세요. 2년전 구축해놓은 룰도 지금 와서 보니 구식되서 계속 업데이트하게 되더군요. 컴터 언어도 계속 진화합니다.. 제 경험상 코딩룰 통일하는데 의견 충돌 제법생길겁니다. 이쪽 바닥 너드들이 사회성들이 부족해서….

      • 하하하 128.***.214.50

        답변 감사합니다. 저도 짬찌끄레기라서 누굴 뽑으라 마라 할 권한이 없어요.
        제가 스크럼마스터가 되는게 나을 것 같을정도로… 사람이 적고 비 IT 회사에요.
        위에 말씀해주신 방법을 적용하도록 해보도록 하겠습니다.

        지금 Angular랑 ASP.NET Core를 쓰려고하는데, 이건 뭐라고 해야하죠?