[Software Engineering] Chapter 10. 코딩 컨벤션 및 네이밍 컨벤션

Coding Convention 이란?

• 특정 프로그래밍 언어별로 권장되는 프로그래밍 스타일이나 방법 등을 포함한 가이드라인
• 파일(디렉토리) 구조, 들여쓰기, 주석, 선언문, 공백, 네이밍 컨벤션, 프로그래밍 원칙, Best Practice 등을 포함
• 보통 각 조직별, 언어별로 약속해서 사용하는 Coding Convention이 있음
• 컨벤션을 안지켰다고 문법적으로(syntax)가 틀린 것은 아님
• 왜 필요한가?
  • 유지보수 비용 절감
  • 코드 가독성 증가 : 소스코드를 읽고, 해석하는데 필요한 노력이 줄어든다
  • 코드 리뷰 시 문법이나 네이밍룰 등 사사로운 것 보다 더 중요한 것에 집중할 수 있또록 하기 위해
• 예) 구글의 HTML/CSS 가이드라인(https://google.github.io/styleguide/htmlcssguide.html)

 

Naming Convention 이란?

• 소스코드에서 변수명, 함수명, 식별자명 등 '이름'을 작명하는 규칙
• 대표적인 Naming Rule
  • camelCase : 단어 시작 대문자. 첫글자는 소문자
  • PascalCase : 모든 단어 시작 대문자. 즉, 첫글자도 대문자
  • snake_case : 단어 사이 _(언더바)
  • kebab-casing : 단어 사이 -(대시)