[개발] 코드 스타일

코드 스타일

왜 코드 스타일을 신경써야 하는가?

코드 스타일을 신경쓴다는 것은 좋은 코드를 짜기 위한 최소한의 노력입니다.

• 가독성 향상
  
  • 일관된 코드 스타일은 코드를 읽고 이해하기 쉽게 만듭니다.
  • 들여쓰기, 괄호 사용, 공백 등의 규칙을 정함으로써 코드를 시각적으로 정리하고 흐름을 파악하기 쉽게 합니다.
  • 특히, 여러 개발자가 참여하는 프로젝트에서 코드 스타일을 통일하면 코드 리뷰 및 유지 보수가 용이해집니다.
• 유지 관리성 향상
  
  • 명확한 코드 스타일은 코드의 버그를 찾고 수정하기 쉽게 만듭니다.
  • 일관된 코딩 방식은 코드의 구조와 의미를 파악하는 데 도움이 되므로, 문제 발생 시 빠르게 원인을 찾아 해결할 수 있습니다.
  • 또한, 코드 스타일 가이드를 통해 코드 형식을 자동으로 정리하는 도구를 사용할 수 있어 유지 관리 작업을 효율적으로 수행할 수 있습니다.
• 협업 향상
  
  • 팀 내 모든 개발자가 동일한 코드 스타일을 사용하면 서로의 코드를 쉽게 이해하고 협업할 수 있습니다.
  • 코드 스타일 가이드는 팀원 간의 의사 소통을 원활하게 하고, 코드 검토 및 병합 과정을 효율적으로 수행하는 데 도움이 됩니다.
  • 특히, 오픈 소스 프로젝트와 같은 여러 개발자가 참여하는 환경에서 코드 스타일 가이드는 필수적인 요소입니다.
• 전문성 향상
  
  • 명확하고 일관된 코드 스타일은 코드의 전문성을 높여줍니다.
  • 코드 스타일 가이드를 통해 코드 형식을 깔끔하게 유지하고, 가독성과 유지 관리성을 향상시킬 수 있습니다.
  • 이는 코드의 품질을 높이고, 개발자의 전문성을 보여주는 지표가 됩니다.
• 코드 리뷰 및 병합
  
  • 코드 리뷰 및 병합 과정에서 코드 스타일은 중요한 역할을 합니다.
  • 일관된 코드 스타일은 코드 리뷰를 쉽게 하고, 코드 병합 시 발생하는 충돌을 줄여줍니다.
  • 또한, 코드 스타일 가이드는 코드 리뷰 기준을 명확하게 정의하여 리뷰 과정을 효율적으로 수행하는 데 도움이 됩니다.

 

코드 스타일 고려 항목

• 항목
  • 들여쓰기 (indent)
    • 2칸 vs 4칸
      • 개인적으로는 4칸을 선호합니다.
      • 공식문서에도 정의가 되어 있으니 그걸 따라가도 좋을거 같습니다.   
  • 공백
    
    • 메소드 정의 시 메소드 명과 괄호 사이의 공백도 고려합니다.
    • 괄호, 콤마, 세미콜론 등의 주변 공백도 고려합니다.
  • 명명 규칙
    • 명명 규칙은 변수, 함수, 클래스 등의 이름을 명확하게 정의하는 데 사용됩니다.
    • 명명 규칙은 코드 스타일 가이드에 정의하는 것이 좋습니다.
    • 고려항목
      • 변수, 함수, 클래스 이름의 형식 (예: 낙타 표기법, 언더스코어 표기법)
      • 접미사 및 접두사 사용 규칙
      • 상수 및 예약어 사용 규칙
      • 참고
        • 구글 스타일 가이드
          • Java : https://google.github.io/styleguide/javaguide.html
          • Go : https://google.github.io/styleguide/go/
  • 코멘트
    
    • 코멘트 작성 시 사용할 문자 (//, /**/) 도 고려합니다.
    • 코멘트 내용 (함수 설명, 변수 설명, 알고리즘 설명 등) 도 고려합니다.
    • 코멘트 스타일 (예: 문장 스타일, 목록 스타일) 도 고려합니다.