Coding Convention ‐ JavaScript - Likelion-JavaScript-Project/d1tto GitHub Wiki

소스파일

스크린샷 2023-07-28 000354
  • 소스파일의 이름은 Camel Case로 작성합니다.

네이밍 기본

// 권장하는 방법
const defaultName = 'd1tto'

// 권장하지 않는 방법
const default_name = 'ditto'

// 권장하는 방법
const button = document.queryselector('button')

// 권장하지 않는 방법
const buttons = document.queryselectorAll('button')
const btn = document.queryselector('button')
  • camel case를 사용합니다.
  • 복수형을 사용하지 않습니다.
  • 줄임말을 사용하지 않습니다.
  • 이벤트 핸들러의 이름은 handler~로 시작합니다.

형식

들여쓰기

  • 모든 들여쓰기는 두 칸의 공백으로 합니다.
  • .을 이용하여 긴 메소드 체인을 작성할 때에는 각 메소드마다 들여씁니다.

구문

  • 한 줄에는 하나의 구문만 작성합니다.
  • 모든 구문의 끝에는 세미콜론 ;을 붙입니다.

공백

  • 한 줄에는 80자를 넘기지 않도록 합니다.
  • 줄을 띄울 때에는 2줄 이상 띄우지 않습니다.

// 권장하는 방법
if (true) {
  console.log('d1tto')
} else {
	console.log('1조')
}

// 권장하지 않는 방법
if(true) {
  console.log('d1tto')
} else{
	console.log('1조')
}

// 권장하는 방법
function d1tto() {
	console.log('d1tto')
}

// 권장하지 않는 방법
function d1tto () {
	console.log('d1tto')
}
  • if, for, catch와 같은 키워드와 소괄호 () 사이에는 한 칸을 띄웁니다.

    단, function의 이름 뒤에 소괄호 ()와는 공백을 만들지 않습니다.

  • else, catch와 같은 키워드 앞에 오는 닫는 중괄호 } 사이에는 한 칸을 띄웁니다.


// 권장하는 방법
const d1tto = true ? console.log('1조') : console.log('0조');

// 권장하지 않는 방법
const d1tto=true?console.log('1조'):console.log('0조');
  • 이항 연산자와 삼항 연산자의 양 쪽에는 한 칸씩 띄웁니다.

// 권장하는 방법
const d1tto = ['경아', '다연', '태일', '준석'];

// 권장하지 않는 방법
const d1tto = ['경아','다연','태일','준석'];

// 권장하는 방법
const d1tto = {
	name: '경아'
};

// 권장하지 않는 방법
const d1tto = {
	name:'경아'
};

// 권장하는 방법
function d1tto(name) {
	return name;
}

// 권장하지 않는 방법
function d1tto( name ) {
	return name;
}
  • ,; 뒤에는 한 칸을 띄웁니다.
  • 객체의 : 뒤에는 한 칸을 띄웁니다.
  • 주석의 기호와 본문 사이에는 한 칸을 띄웁니다.
  • 소괄호 ()와 대괄호 []의 양쪽에는 공백을 만들지 않습니다.

중괄호

  • 구문이 하나더라도 중괄호 {}는 생략하지 않습니다.
💡

중괄호 {}의 사용법은 Kernighan and Ritchie Style을 따릅니다.

  • 여는 중괄호 { 이전에는 줄을 바꾸지 않습니다.

  • 여는 중괄호 { 이후에 줄을 바꿉니다.

  • 닫는 중괄호 } 이전에 줄을 바꿉니다.

  • 닫는 중괄호 } 이후에 줄을 바꿉니다.

    단, else, catch, while, ., ;, )가 뒤따를 경우에는 줄을 바꾸지 않습니다.

변수

  • 한 줄에는 하나에 변수만 선언합니다.
  • var는 사용하지 않습니다.
  • 지역 변수는 사용되는 지점과 가장 가까운 곳에 선언합니다.
  • const 선언문을 먼저 작성하고, 다음에 let 선언문을 작성합니다.

배열

  • 배열의 마지막 요소의 끝에도 ,을 작성합니다.

객체

  • 객체의 key에는 따옴표를 사용하지 않고,

    value에는 작은 따옴표 ''를 사용합니다.

  • keyvalue의 값이 같을 경우에는 단축 표기법을 사용하며,

    단축 표기법으로 작성된 key가 상단에 선언되도록 합니다.

함수

  • 함수를 선언할 때에는 함수 선언문을 사용합니다.

    다만, 구문이 단순한 경우에는 화살표 함수를 사용할 수 있습니다.

  • forEach, map과 같은 곳에서 함수식을 사용할 경우에는 화살표 함수를 사용합니다.

💡

함수의 이름 show~ ➡️ 출력할 때 get~ ➡️ 값을 얻을 때 calc~ ➡️ 계산할 때 create~ ➡️ 생성할 때 check~ ➡️ 확인하고 불린 값을 반환할 때

문자열

  • 문자열을 선언할 때에는 작은 따옴표 ''를 사용합니다.
  • 문자열 내에 작은 따옴표가 포함될 경우에는 템플릿 리터럴을 사용합니다.

Switch

  • switch문에서 break는 생략하지 않습니다.
  • case 또는 default의 사이에는 한 줄을 띄웁니다.
  • default는 마지막에 위치합니다.
⚠️ **GitHub.com Fallback** ⚠️