[javascript] 코드 작성에 대한 팀 내 공유 규칙 정하기

05 Dec 2023

javascript

팀 내에서의 일관된 코드 작성은 소프트웨어 개발의 효율성을 향상시키고 유지보수를 용이하게 합니다. 이를 위해 자바스크립트 코드 작성에 대한 팀 내 공유 규칙을 명확하게 정의하는 것이 중요합니다.

들어가기

코드 작성 규칙을 정하기 전에 팀원들과 논의를 진행하고 이해를 도모해야 합니다. 팀원들이 코드 작성에 어떤 스타일을 선호하고 어떤 표준을 따를 것인지에 대해 합의하는 것이 중요합니다.

들여쓰기

들여쓰기는 코드의 가독성을 높이는 데 중요한 역할을 합니다. 들여쓰기 방식은 스페이스와 탭 중에서 선택할 수 있지만, 팀 내에서 일관성 있게 선택되어야 합니다.

// 스페이스를 사용한 들여쓰기
function foo() {
  if (true) {
    console.log("Hello, World!");
  }
}

// 탭을 사용한 들여쓰기
function foo() {
	if (true) {
		console.log("Hello, World!");
	}
}

네이밍 규칙

변수, 함수, 클래스 등의 이름을 일관성 있게 작성해야 합니다. 가독성을 위해 다음과 같은 네이밍 규칙을 따릅니다.

변수와 함수: 카멜 케이스(camel case)를 사용합니다. 예: myVariable, getUsers()
클래스와 생성자: 파스칼 케이스(Pascal case)를 사용합니다. 예: MyClass, Person()
상수: 대문자 스네이크 케이스(Snake case)를 사용합니다. 예: CONSTANT_NAME

주석

주석은 코드의 이해를 돕고 나중에 코드를 수정하거나 유지보수할 때 유용합니다. 코드에 주석을 추가하여 다음과 같은 사항을 명시해야 합니다.

코드의 목적과 동작에 대한 설명
복잡한 알고리즘의 동작 방식
주의사항이나 예외 사항

// 변수에 값을 할당합니다.
let myVariable = 10;

// 두 숫자의 합을 반환합니다.
function addNumbers(a, b) {
  return a + b;
}

함수 작성

함수는 재사용성과 가독성을 고려하여 작성해야 합니다. 다음은 함수 작성에 대한 권장 사항입니다.

함수는 하나의 기능만 수행하도록 작성합니다.
함수명은 해당 기능을 명확하게 표현해야 합니다.
필요한 경우 매개변수와 반환값을 명시합니다.

// 숫자의 절대값을 반환하는 함수
function getAbsoluteValue(number) {
  return Math.abs(number);
}

변수 선언

변수는 코드의 가독성과 범위 또는 유효성을 유지하기 위해 필요한 범위 내에서 선언되어야 합니다.

변수 선언은 let 또는 const 키워드를 사용합니다.
변수 초기화는 선언과 동시에 이루어집니다.
변수명은 명확하고 의미있게 작성합니다.

let myVariable = "Hello, World!";
const PI = 3.14159;

코드 포맷팅

일관된 코드 포맷팅은 가독성을 향상시키는 역할을 합니다. 다음은 코드를 포맷팅하는 규칙의 일부입니다.

중괄호는 독립적인 줄에 작성되어야 합니다.
적절한 들여쓰기를 사용하여 코드의 계층 구조를 명확하게 표현합니다.
세미콜론(;)으로 문장을 마감합니다.

// 예시 코드
if (x > 0) {
  console.log("Positive");
} else if (x < 0) {
  console.log("Negative");
} else {
  console.log("Zero");
}

참고 자료

팀 내에서 일관된 코드 작성 규칙을 유지함으로써 프로젝트의 효율성을 높일 수 있습니다. 위의 규칙을 참고하여 팀원들과 함께 코드 작성에 대한 공유 규칙을 정의해 보세요!

목차