네이밍 규칙 (Naming Convention)
Subject
개발 과정에 Resource 나 Source 파일, Class나 Object의 이름 또는 변수, 타입, 함수, 그 외 Entity, Document의 이름 명명 규칙을 알아봅니다.
네이밍 규칙(Name Convention)을 사용하는 이유
- 소스 코드를 읽고 이해하는데 필요한 비용 절약
- 코드 리뷰 시 이슈에 좀 더 집중할 수 있도록 도와줍니다.
- Code quailty review tool이 구문 및 스타일 설정 이외에 중요한 결함에 대해 알려줄 수 있도록 도와줍니다.
네이밍 규칙은 현재까지도 의견이 갈리는 부분으로, 각 언어별로 권장하는 Convention에 차이가 있으며 회사나 팀에서 자체적인 규칙을 정하여 사용하기도 합니다.
이 글에서는 현재 보편화된 네이밍 규칙을 설명합니다.
표기법은 일반적인 요소(Common element)에 의한 표기법과,
규칙이나 요구사항, 도메인에 따른 하이브리드 규칙이 적용된 표기법이 있습니다.
| 네이밍 표기법 종류 | 설명 | 예제 |
| 카멜 케이스 camelCase |
첫 글자는 소문자로 시작하며, 두번째 단어부터는 띄어쓰기없이 대문자로 표기 | visitorName |
| 파스칼 케이스 PascalCase |
모든 단어를 띄어쓰기없이 대문자로 시작 | VisitorName |
| 스네이크 케이스 snake_case |
모든 단어를 소문자로 작성하고 단어사이에 언더바( _ )를 넣습니다. | visitor_name |
| 케밥 케이스 kebab-case |
모든 단어를 소문자로 작성하고 단어사이에 대시( - )를 넣습니다. | visitor-name |
| *헝가리언 표기법 (Hungarian notation) |
이름에 목적(Purpose)나 타입(type)을 접두사로 기재합니다. 헝가리식 표기법을 참고하여 작성합니다. | szName (sz는 변수가 null로 끝나는 문자열임을 나타냅니다.) |
* 하이브리드 규칙
추가로 스네이크 케이스를 대문자로만 표현한다면 앞에 "UPPER"을 붙혀 Upper Snake Case(대문자 스네이크 케이스)로 표기하듯히 조금씩 변형시킬 수 있습니다. (소문자는 lower)
위의 다섯가지외에 다른 케이스는 하단의 표를 참고하시면 됩니다.
저의 경우엔 안드로이드 앱을 위주로 개발하다보니 코틀린 Coding Convention을 따르며, 카멜 케이스, 파스칼 케이스, 스네이크 케이스 위주로 작성을 하고 있습니다.
이와 관련해서는 추후 다루는 글을 올려보도록 하죠.
Naming convention (programming) - Wikipedia
In computer programming, a naming convention is a set of rules for choosing the character sequence to be used for identifiers which denote variables, types, functions, and other entities in source code and documentation. Reasons for using a naming conventi
en.wikipedia.org
ⓒ 굿햄2022. daryeou@gmail.com all rights reserved.
'디자인패턴 > Convention' 카테고리의 다른 글
| 소프트웨어/앱 빌드버전 관리 규칙, Semantic Versioning (시맨틱 버저닝) (1) | 2022.06.04 |
|---|
댓글