코딩 컨벤션 - boostcamp-2020/Project15-C-Client-Based-Formula-Editor GitHub Wiki
네이밍 규칙 정하기
✔️ 네이밍 컨벤션
클래스
- PascalCase
- 명사 또는 명사구문으로 표기
상수
- SNAKE_CASE
변수
- camelCase
CSS
- div -> Container, Wrapper, Box, Contents
- className, id -> kebab-case
나머지
- lowerCamelCase
✔️ 코딩 컨벤션
-
들여쓰기 두 칸
-
세미콜론 사용
-
문자열은 홑따옴표 사용 ('')
-
컴포넌트 선언시에 function / 이하 나머지 함수는 Arrow Function을 사용
-
컴포넌트를 제외한 파일명은 단어가 여러개일 경우 '-' 로 구분한다. ex) category-model.js'
-
컴포넌트의 파일명은 PascalCase를 사용한다. ex) LoginPage.jsx
-
Custom Hook의 경우에는 use + camelCase를 사용한다. ex) useCustomHook
-
DB 테이블 명은 snake case로 작성한다. (issue_label)
-
가져온 DB 모델은 pascal case로 작성한다. (IssueLabel)
-
[Backend] module.exports = ... / require(...) (commonJS)
-
[Frontend] default export = ... / import ... from ... (ES6 module)
-
만약 주석이 필요한 경우 // TODO: 해야 할 일 혹은 한 일을 적어준다.