Coding‐convention

네이밍 규칙

일반 규칙

이름은 영문 소문자, 대문자, 숫자, 언더스코어 2개 (__) 로 작성한다.

시작 이름

이름은 영문 소문자로만 시작할 수 있다.

코드 작성 규칙

기본 규칙

코드를 작성할 때, 다음과 같은 기본 규칙을 준수한다.

• HTML 은 W3C Validation DTD 의 명세에 맞게 작성하며, 문법 검사를 통과하여야 한다.

• 모든 요소와 속성은 소문자로 작성한다.

잘못된 예: <SPAN Class=”desc”>간단한 설명</SPAN>

• 특수 기호는 문자 엔티티 참조를 사용하여 코드로 변환한다.

빈 줄

빈 줄의 간격은 1줄을 초과하지 않는다.

---

기본 네이밍 컨벤션

폴더 네이밍은 소문자로만 구성되어야 한다 lib/dom js/common

파일 네이밍은 카멜케이스로만 구성되어야 한다 typeOf.js bindEvent.js

이미지 파일들은 해당브랜치명과 + 스네이크케이스로만 구성되어야 한다 main_image category_image

HTML/CSS 클래스 네이밍 컨벤션

HTML/CSS 파일 내에서 클래스명은 케밥케이스로 구성되어야 한다 kebab-case

Javascript 네이밍 컨벤션

Array

자바스크립트에서 변수이름에 복수로 표기해야한다 const **fruitNames** = ['apple', 'banana', 'cucumber'];

Boolean

Bolean값은 전부 is~~으로 구성되어야 한다 const isOpen = true;

Functions

이벤트 리스너 관련 함수는 (handle~)로 구성되어야 한다

어떤 값을 가져오는 것과 관련된 함수는 (get~)로 구성되어야 한다

어떤 값을 세팅하는 것과 관련된 함수는 (set~)로 구성되어야 한다

함수 선언 및 할당시 화살표 함수를 기본으로 한다

화살표함수는 명시적으로 return 명시해야한다

const page = () => { return ... }