Naming Convention

여러 가지 네이밍 컨벤션

3분이면 읽을 수 있어요.
목차

네이밍 컨벤션(Naming Convention)

네이밍 컨벤션은 코드를 작성할 때 변수, 함수, 클래스, 파일 등의 이름을 지을 때 사용하는 규칙입니다. 네이밍 컨벤션을 잘 지키면 코드의 가독성을 높일 수 있고, 협업 시에도 코드를 이해하기 쉬워집니다. 다음은 여러 가지 네이밍 컨벤션을 정리한 것입니다. 일반적으로 영어를 사용하며, kebab-case, snake_case, camelCase, PascalCase 등의 케이스를 사용합니다.

  • kebab-case: 단어 사이에 하이픈(-)을 사용하는 방식
  • snake_case: 단어 사이에 언더바(_)를 사용하는 방식
  • camelCase: 첫 단어를 제외한 나머지 단어의 첫 글자를 대문자로 표기하는 방식
  • PascalCase: 모든 단어의 첫 글자를 대문자로 표기하는 방식
  • SCREAMING_SNAKE_CASE: 모든 글자를 대문자로 표기하고 단어 사이에 언더바(_)를 사용하는 방식

자바스크립트(JavaScript)

변수 종류케이스예시
상수SCREAMING_SNAKE_CASEMAX_LENGTH
객체, 변수, 함수, 인스턴스camelCasemaxLength, fetchPost, user
클래스, 생성자 함수PascalCaseStudent
모듈camelCaseuserService
이벤트 핸들러“on”로 시작하는 camelCaseonSubmit

리액트(React)

변수 종류케이스예시
폴더, 파일kebab-case/user-components
컴포넌트 폴더PascalCase/ProductList
컴포넌트 파일.jsx / .tsx 확장자index.tsx, ProductList.tsx
컴포넌트PascalCaseProductList
PropscamelCaseuserName
State”set”으로 시작하는 camelCase[count,setCount] = useState(0)
이벤트 핸들러“handle”로 시작하는 camelCasehandleClick
이벤트 프로퍼티“on”으로 시작으로 camelCaseonClick
hooks“use”로 시작하는 camelCaseuseState, useEffect, useUser

데이터베이스(Database)

분류변수 종류케이스예시
RDB테이블snake_case + 복수형user_accounts
snake_casefirst_name

API(Application Programming Interface)

분류변수 종류케이스예시
Rest api리소스명사형 / kebab-case
”_” 대신 “-” 사용
복수형은 복수형
…com/user-profile
…com/items
결과 데이터 변수snake_caseitem_list
JSON모든 키camelCasecamel