[TIL] 2023/11/08 코딩 컨벤션 특강

코딩 컨벤션(가독성 높이기)

1.버그가 많아지고,
2.코드 리뷰가 안 좋아지고,
3.코드가 중복되고,
4.충돌이 일어난다.

• 용어 규칙
  camelCase
  첫 글자를 제외한 모든 단어의 시작을 대문자로 쓴다.
  js를 이용해 백엔드 개발 시, 변수,객체의 속성, 클래스의 메소드, 함수 이름에 사용된다.
  PascalCase
  첫 글자를 포함한 모든 단어의 시작을 대문자로 쓴다.
  js를 이용해 백엔드를 개발 시, 클래스 이름에 사용된다.
  snake_case
  밑줄을 사용하는 것이다.
  js를 이용해 백엔드 개발 시, 일반적으로 사용하지 않는다.
  kebab-case
  단어를 하이픈(-)으로 연결한다.
  js를 이용해 백엔드 개발 시, 파일이름,api경로에 사용된다.
  UPPER_SNAKE_CASE(상수 코드 내에서 반복적으로 사용 되거나, 어디에 사용 되는 값 인지 알 수 없는 경우)
  밑줄을 사용하고, 모든 문자를 대문자로 표시한다.
  js를 이용해 백엔드 개발 시, 상수,환경변수의 이름에 사용된다.

// Boolean 타입
if(money > 99999999 && age < 30){ 영앤리치 클럽 가입}

const isYoungAndRich = money > 999999 && age < 30
if(isYoungAndRich) { 영앤리치 클럽 가입 }

// ESLint ( 규칙에 대한 에러를 보여준다.
보통 Airbnb 코드 따라함.)

// 인레이(타입스크립트를 보여주다?)

• GIT 커밋 메세지(컨벤셔널 커밋)
  feat: 새로운 기능이 추가된 경우(feat/naming-기능-구현)
  fix: 버그를 수정한 경우
  docs: 코드 수정 없이 문서만 추가된 경우
  style: 코드 포맷팅을 수정한 경우
  chore: 그 밖의 잡다한 일을 처리한 경우

• 브랜치 이름
  개인 브랜치를 사용하는 것은 좋지 않다.
  풀 리퀘스트 (이슈) 사용하기
  commit 자주하기