Skip to content

CodingConvention

nawhes edited this page Nov 11, 2021 · 2 revisions

공통

  • 약어사용 줄이기 (img -> image)
  • 약어 및 이니셜은 항상 모두 대문자이거나 모두 소문자
  • 영문자 소문자, 숫자, 하이픈, 언더바만 허용

파일이름 컨벤션

assets

  • 영문자 소문자, 숫자, 하이픈만 허용
  • 영문자 소문자로 시작해야 함
  • 단어간 구분은 하이픈으로 사용

js, jsx, ts, tsx

  • export default가 있을 경우 파일명으로 사용
  • 그 외 camelCase

css, scss, sass

  • 영문자 소문자와 .(dot)만 허용

변수이름 컨벤션

html, css

  • 자바스크립트에 적용될 클래스이름은 camelCase
  • css에 적용될 클래스 이름은 kebab-case

js, jsx, ts, tsx

  • 클래스이름, 오브젝트 이름은 PascalCase
  • 변수 이름, 함수, enum 이름은 camelCase
  • 클래스이름, 오브젝트 이름, 변수 이름은 명사 사용
  • 함수 이름은 동사로 시작

타입스크립트 컨벤션

  • 인터페이스는 prefix 대문자 I, 그외에는 클래스 명명규칙을 따름
  • 상수는 모두 영문자 대문자를 사용하고 _(under bar)로 단어 구분
  • 상수는 global.d.ts에 정의

데이터베이스 컨벤션

mysql

공통
  • 소문자, snake_case
테이블
  • 단수형 사용
  • has, and는 many-to-many 테이블에만 이용
컬럼
  • auto increment 속성의 PK는 테이블_id으로 명명
  • FK는 참조 테이블의 PK이름을 그대로 사용
트리거
  • AFTER 트리거는 tra를 prefix로 사용
  • BEFORE 트리거는 trb를 prefix로 사용
  • 트리거 이벤트를 suffix로 사용
  • 예 (prefix_table_event)
    • trg_user_update

mongodb

공통
  • camelCase

reference

naver 스타일 가이드

https://github.com/naver/eslint-config-naver/blob/master/STYLE_GUIDE.md

airbnb 스타일 가이드

https://github.com/airbnb/javascript

구글 타입스크립트 스타일 가이드

https://google.github.io/styleguide/tsguide.html

구글 자바스크립트 스타일 가이드

https://google.github.io/styleguide/jsguide.html

Clone this wiki locally