네이밍 컨벤션 정의, 종류

백우진·2024년 1월 10일
0
post-thumbnail

네이밍 컨벤션

하나 이상의 영어 단어로 구성된 식별자를 만들 때 가독성 좋게 단어를 한눈에 구분하기 위해 규정한 명명 규칙

컨벤션의 선택은 주로 해당 언어나 프레임워크의 관례를 따른다. 코드베이스 내의 일관성을 유지하고 가독성을 높이기 위해서는 프로젝트 팀이나 개발자 간에 네이밍 컨벤션에 대한 합의가 필요하다. 종종 언어나 프레임워크의 공식 문서에는 해당 언어에서 권장하는 네이밍 컨벤션에 대한 지침이 포함되어 있다.

네이밍 컨벤션 종류

1. 카멜 표기법(camelCase)

  • 낙타(카멜) 등처럼 내려갔다 올라가는 모양이라 하여 지어진 이름
    단어가 여러 개 붙을 때, 앞 단어를 제외한 첫자를 대문자로 표기
  • java, C#, js 등의 언어들에서 권장
const dailyUserTable;
const getCamelCaseExample;

2. 파스칼 표기법( PascalCase )

  • 모든 단어의 앞자가 대문자로 시작(단어의 수와 상관없음)
  • 네임스페이스, 이벤트, 프로퍼티, 클래스 네임을 지정할 때 주로 사용
  • 클래스 등에서 많이 사용
const DailyUserTable;
const PascalCaseExample;

3. 스네이크 표기법(snake_case), 팟홀 표기법(pothole_case)

  • 모든 단어가 소문자로 표시
  • 다른 의미를 갖는 단어들의 조합에서 각 단어의 구분을 위하여 언더바( _ )를 붙임
  • 단어 사이의 '_'가 뱀처럼 보인다고 해서 유래
  • 언더바 표기법 이라고도 불림
    C++, Python에서 권장
const daily_user_table;
const snake_case_example;

4. 헝가리안 표기법

  • 접두어에 자료형을 붙임
  • 마이크로소프트 개발자 중 헝가리 프로그래머가 쓰던 변수 명명법
  • 현재는 안티 패턴으로 죽어가고 있는 표기법, 가끔씩 레거시 코드에서 보임
const strDailyUserTable;
const intCountNumber;

5. 세종대왕 표기법

  • 어색한 영어보다 이해하기 쉬운 한글로 짓는 컨벤션
  • 한국사람들은 보다 이해하기 쉽고 눈에 잘 들어오는 코드를 작성 할 수 있음.
  • 단! 명확한 컨벤션이 있어야 한다.
// 이해 하기 쉽도록 작성하는 것이 제 1 원칙
// 한글이라도 어려운 용어(고어, 한자어) 사용은 금지
const 사용자가_선택한_결제_파라미터_타입;

// Boolean일 경우에
let 소유자일까 (X)
let 소유자인가 (O)

// 언더바(_)를 이용해 구분한다.
let 국가지방자치단체공공단체금융사여부 (X)
let 국가지방자치단체_공공단체_금융사_여부(O)

구글 코드 스타일 가이드

참고하면 좋을 만한 자료
구글 스타일 가이드

profile
안녕하세요.

0개의 댓글