코딩 컨벤션

프론트엔드에서 일관성 있고 가독성 높은 코드를 작성하기 위한 코딩 컨벤션을 정의합니다.
이 컨벤션은 ESLint와 Prettier를 사용하여 자동화된 방식으로 적용됩니다.

프로젝트 설정

ESLint와 Prettier를 설정하여 코드 품질을 자동으로 검증하고 일관된 코드 스타일을 유지합니다.

Vue 공식 스타일 가이드를 따르며, 프로젝트 루트에 .eslinttc.cjs를 사용합니다.

프로젝트 루트에 .prettierrc.cjs를 사용합니다.

컴포넌트 이름: PascalCase, 명사형 (ex. MyComponent)
템플릿 내부: PascalCase (ex. MyComponent)
- 속성(attribute) 이름: kebab-case (ex. class="my-attribute")

JSDOC 주석을 사용하여 함수 및 클래스에 대한 설명을 작성합니다.
클래스 혹은 함수(컴포넌트)의 처음 부분은 이름 및 설명을 포함하는 패키지 주석으로 시작합니다.

javascript
/*
함수명: addFunction
설명: 두 수를 더하는 함수
매개변수: a, b
*/
function addFunction(a, b) {
  return a + b;
}