자바스크립트 스타일 가이드 및 코딩 규칙

13 Oct 2023

javascript

자바스크립트는 다양한 스타일로 작성될 수 있지만, 일관된 코딩 스타일을 사용하는 것은 코드의 가독성과 유지보수성을 향상시키는 중요한 요소입니다. 이 글에서는 자바스크립트 코드를 작성할 때 따라야 하는 주요 가이드라인과 코딩 규칙을 소개하겠습니다.

1. 변수와 상수

변수 및 상수 이름은 의미를 잘 전달할 수 있도록 지어야 합니다.
변수 이름은 카멜 케이스(camelCase)를 사용하며, 상수는 대문자 스네이크 케이스(UPPER_CASE_SNAKE_CASE)를 사용합니다.
변수 및 상수의 이름은 명사로 시작해야 하며, 다른 사람이 이해하기 쉽고 의도를 알 수 있도록 해야 합니다.

예시:

let userName = "John";
const MAX_COUNT = 10;

2. 들여쓰기

들여쓰기는 일관된 스타일로 사용해야 합니다. 공백 2개 또는 4개를 사용하는 것이 일반적입니다.
탭(tab)은 사용하지 않고, 스페이스(space)를 사용해야 합니다.
브라켓({})을 열 때는 들여쓰기를 하고, 해당 브라켓이 닫힐 때는 동일한 수준으로 들여쓰기를 합니다.

예시:

function showMessage() {
  console.log("Hello, world!");
}

3. 주석

코드를 이해하기 쉽게 주석을 작성해야 합니다.
주석은 코드의 목적이나 동작 방식을 설명하는 데에 사용되어야 합니다.
주석은 다른 사람들이 코드를 이해하기 쉽도록 돕는 역할을 해야 합니다.

예시:

// 사용자의 이름을 출력하는 함수
function printUserName(user) {
  console.log("User name: " + user.name);
}

4. 함수

함수 이름은 동사로 시작해야 하며, 의도를 나타낼 수 있도록 지어야 합니다.
함수의 인수는 명사로 지정해야 하며, 함수 이름과 일관성을 유지해야 합니다.
함수는 재사용 가능하도록 작성해야 하며, 한 가지 기능만을 수행하도록 해야 합니다.

예시:

function calculateArea(width, height) {
  return width * height;
}

5. 에러 처리

예외 상황을 처리하기 위해 try-catch 문을 사용해야 합니다.
예외 처리를 하지 않으면 예기치 않은 오류가 발생할 수 있습니다.
예외 처리를 사용해 코드의 안정성을 높이고, 오류를 적절히 처리할 수 있도록 해야 합니다.

예시:

try {
  // 예외가 발생할 수 있는 코드
} catch (error) {
  // 예외 처리 로직
  console.log("An error occurred: " + error.message);
}

6. 참조

자바스크립트 스타일 가이드 및 코딩 규칙은 개발자들의 논의와 공통의 원칙을 따라야 합니다.
Airbnb JavaScript 스타일 가이드와 Google JavaScript 스타일 가이드는 널리 알려진 자바스크립트 스타일 가이드입니다.
이러한 참조를 참고하여 코드 스타일을 선택할 수 있습니다.

7. 요약

자바스크립트 코드를 작성할 때 일관된 스타일과 코딩 규칙을 따르는 것은 중요합니다. 변수와 상수의 이름을 명확하게 지어야 하며, 들여쓰기와 주석을 적절하게 사용해 코드의 가독성을 높이는 것이 좋습니다. 함수를 재사용 가능하고 명확하게 작성하며, 예외 처리를 통해 코드의 안정성을 높이는 것도 중요합니다. 참조 자료를 통해 더 많은 자바스크립트 스타일 가이드를 참고하고, 동료 개발자와 협업하여 일관된 코딩 규칙을 유지하는 것을 추천합니다.

해시태그: #JavaScript #코딩규칙