네이밍 규칙(Repository, )

less than 1 minute read

Published:


Repository 명명 규칙

프레임워크(or언어) - 이름 - 기능

###

  1. 소문자를 사용해라
  2. 대시(-)를 사용해라
  3. 구체적으로 작성해라
  4. 일관성 있게 작성해라

예시

  1. algorithm-study
  2. mysql-study

기본적인 명명 규칙

  1. Git 저장소 이름에 사용되는 Keyword는 의미론(Sementic)적으로 작성합니다.
  2. Git 저장소 이름에 사용되는 Keyword의 표기는 카멜(Camel) 표기법을 사용합니다.
  3. Git 저장소 이름 규칙(Naming convention)에 사용되는 고유 명사는 대문자로 표기합니다.
  4. Git 저장소 이름에 사용되는 Keyword 간의 구분은 ‘하이픈(-)’을 사용합니다.
  5. Git 저장소 이름 규칙(Naming convention)은 Proejct name-Project development
  6. enviroment-Project purpose 의 형태로 제안합니다.
  7. (선택 사항) Git 저장소 이름 규칙은 git repository라는 것을 나타내기 위해 git.으로 시작합니다.

네이밍 규칙

네이밍규칙을 왜 사용하는가?

  • 소스 코드를 읽고 이해하는데 필요한 비용 절약
  • 코드 리뷰 시 이슈에 좀 더 집중할 수 있도록 도와줌

보편적인 네이밍규칙

1. 카멜 케이스(camel Case)
첫 글자는 소문자, 두번째 단어부터는 띄어쓰기 없이 대문자로 표기
ex. visitorName

2. 파스칼 케이스(PascelCase)
모든 단어를 띄어쓰기없이 대문자로 시작
ex. VisitorName

3. 스네이크 케이스(snake_case)
모든 단어를 소문자로 작성하고 단어사이에 언더바를 넣기
ex. visitor_name

4. 케밥 케이스(kebab-case)
모든 단어를 소문자로 작성하고 단어사이에 대시를 넣기
ex. visitor-name