[javascript] 프로젝트에 맞는 코드 컨벤션 가이드 라인 작성하기

05 Dec 2023

javascript

프로젝트의 코드 컨벤션은 코드의 일관성과 가독성을 유지하는 데 매우 중요합니다. 다른 개발자들이 프로젝트에 참여하거나 유지보수를 할 때도 이러한 가이드라인을 따를 수 있으므로 프로젝트의 효율성을 높일 수 있습니다.

1. 변수와 함수 네이밍 규칙

변수와 함수의 이름은 의미를 잘 전달할 수 있도록 명확하고 간결하게 작성해야 합니다.
변수의 이름은 소문자를 사용하고, 여러 단어를 사용할 경우에는 띄어쓰기 대신에 카멜케이스(camelCase)를 사용합니다.
함수의 이름은 동사로 시작하고, 변수 네이밍 규칙과 동일하게 작성합니다.
클래스와 생성자의 이름은 파스칼케이스(PascalCase)를 사용합니다.

예시:

let userName = "John";
function calculateSum(a, b) { ... }
class Car { ... }

2. 들여쓰기와 인덴트

들여쓰기와 인덴트는 코드의 가독성을 높이기 위해 중요합니다. 일반적으로 프로젝트에서는 스페이스 2개 또는 4개를 사용하는 것이 권장됩니다.

예시:

function calculateSum(a, b) {
  let sum = 0;
  for (let i = a; i <= b; i++) {
    sum += i;
  }
  return sum;
}

3. 주석 작성 규칙

주석은 코드의 이해를 돕고, 다른 개발자들이 코드를 쉽게 파악할 수 있게 도와줍니다. 주석은 코드가 아닌 설명이므로 명확하고 간결하게 작성되어야 합니다.

코드 블록 위에 대표적인 역할과 기능을 주석으로 작성해야 합니다.
주석은 영어로 작성하고, 문법적인 에러를 피하기 위해 문장의 첫 글자는 대문자로 작성합니다.
주석의 길이는 한 줄을 넘어가면 가독성을 해칠 수 있으므로 적절한 길이를 유지해야 합니다.

예시:

// Calculate the sum of numbers from a to b
function calculateSum(a, b) {
  // Initialize the sum variable
  let sum = 0;
  
  // Iterate through the numbers from a to b and add them to the sum
  for (let i = a; i <= b; i++) {
    sum += i;
  }
  
  // Return the final sum
  return sum;
}

4. 라이브러리 및 프레임워크 사용 규칙

프로젝트에서 라이브러리나 프레임워크를 사용할 때도 일관된 컨벤션을 유지해야 합니다.

외부 라이브러리를 사용할 때는 해당 라이브러리의 네이밍 규칙을 따르는 것이 좋습니다.
코드베이스에서는 외부 라이브러리와 구분하기 위해 변수 및 함수 이름에 접두사를 사용하는 것이 좋습니다.

예시:

import React from 'react';

function App() {
  const [count, setCount] = useState(0);

  function handleIncrement() {
    setCount(count + 1);
  }

  return (
    <div>
      <h1>Counter: {count}</h1>
      <button onClick={handleIncrement}>Increment</button>
    </div>
  );
}

프로젝트에 맞는 코드 컨벤션을 정하는 것은 모든 개발자가 협업할 때 매우 중요합니다. 위의 규칙을 참고하여 프로젝트 팀과 함께 일관된 코드 컨벤션 가이드라인을 작성해 보세요. 이는 코드의 가독성과 유지보수의 용이성을 향상시킵니다.