프로그래밍 명명 규칙 (1)

Ginie·2020년 12월 2일
0

프로그래밍 기초

목록 보기
1/11
post-thumbnail

프로그래밍 이름 지정 규칙

왜 이름 지정 규칙을 사용해야하나요?

  • 소스 코드를 잘 읽고 이해하기 위해
  • 코드 검토 할 때 더 잘 할 수 있게 하기 위해
  • 코드 품질 검토 도구가 더 중요한 문제를 보고 할 수 있게 하기 위해

한 마디로 코드 쉽게 읽고, 개발자 도구에서 더 중요한 문제를 발견할 수 있고, 코드 검토도 더 잘 할 수 있게 하기 위해서!

이름을 잘 지으면 얻는 장점!

  • 함수, 변수, 클래스 이름 등 식별자를 통해 정보를 제공 할 수 있음

    const dataGet = 0
    ☝ 이 변수는 데이터를 얻어오것에 쓰이는 변수라는 정보를 얻을 수 있다.

  • 같은 개발 팀 내에서 일관성을 가지고 코드를 짤 수 있음
  • 자동화 된 리팩토링을 사용 할 때, 이름을 교체하거나 검색 할 때 쉽게 할 수 있음
  • 애매모호 할 때 명확성을 높일 수 있음
  • 작업 할 때 깔끔하게 보이고, 전문적으로 보일 수 있음 (지나치게 긴 이름 X, 귀여운 이름도 X)
  • 다른 팀과 작업하고 병합 할 때 이름 때문에 생기는 충돌을 막을 수 있음
  • 프로젝트를 핸드오버(다른 곳으로 전송하거나 넘기는 것)할 때 의미있는 데이터를 제공
  • 오랜시간이 지나도 알아 볼 수 있음

이름을 지어보자!

1. 식별자의 길이

  • 모든 명명 규칙의 기본 요소!
  • 식별자에 허용되는 한정된 수의 개별 문자
  • 고려 사항
    1. 더 짧은 식별자는 입력하기 편하다 👍
    2. 하지만 매우 짧은 식별자는 비추 👎 (자동 리팩토링이 매우 어려움, 충분한 정보를 주지 못함, 너무 모호해 보임)
    3. 더 긴 식별자는 시각적으로 혼란을 줄 수 있음
    const getMyNewPhoneBookNumber = "Number"

2. 대소 문자 및 숫자

  • 일부 명명 규칙은 문자가 대문자인지 소문자인지 제한함

3. 여러 단어 식별자

  • 일반적으로 "의미 있는 식별자 사용" 을 권장 사항으로 함
  • 한 단어가 여러 단어 만큼 의미가 없거나 구체적이지 않을 수 있음
  • 두개 이상의 단어를 포함하는 "복합" 식별자를 사용 const imageContainer = []
  • 대부분의 프로그래밍 언어는 식별자에 공백을 허용하지 않음

구분자로 구분된 단어

  • 영숫자가 아닌 문자로 별도의 단어를 구분하는 것
  • 일반적으로 "-"와 "_"가 있음 (CSS에서 많이 사용)
  • 대소 문자로 구분된 단어 (사용하는 언어마다 조금씩 틀릴 수 있음)
//CSS
<div class="data-container"></div>

//JavaScript
const myName = "Ginie"
			여러 단어 식별자 형식
          

twowords : flat case
TWOWORDS : upper flat case
twoWords : (lower) camelCase , dromedaryCase
TwoWords : PascalCase, (upper) CamelCase , StudlyCase
two_words : snake_case , pothole_case
TWO_WORDS : SCREAMING_SNAKE_CASE , MACRO_CASE, CONSTANT_CASE
Two_Words : Camel_Snake_Case
two-words : kebab-case, dash-case, lisp-case
TWO-WORDS : TRAIN-CASE, COBOL-CASE, SCREAMING-KEBAB-CASE
Two-Words : Train-Case, HTTP-Header-Case

profile
느리지만 꾸준한 프론트엔드 주니어 개발자 🐢

0개의 댓글