[개발규칙]코드 컨벤션 - gyunam-bark/nb02-how-do-i-look-team1 GitHub Wiki

명명 규칙 (Naming Conventions)

분류	규칙	예시
변수/함수/메서드	camelCase	userName, getUserProfile
클래스/컴포넌트	PascalCase	StyleController, CurationService
상수	SCREAMING_SNAKE_CASE	MAX_TAGS_COUNT, API_URL
파일/폴더	kebab-case	style-controller.js, error-handler.js
데이터베이스 필드명	백엔드 코드와 일관되게 camelCase

주석 (Comments)

"Why"를 설명

무엇을(What) 했는지보다 왜(Why) 그렇게 코드를 작성했는지 설명합니다.

(예: // API 응답 데이터 크기를 줄이기 위해 특정 필드만 선택적으로 포함)

복잡한 로직 설명

복잡한 알고리즘, 비즈니스 규칙, 또는 중요한 계산 로직 앞에 주석을 추가합니다.

TODO/FIXME 주석 활용

// TODO: 향후 구현해야 할 기능 또는 개선 사항 (예: // TODO(2025-06-04, John): 이미지 리사이징 기능 추가)
// FIXME: 알려진 버그 또는 문제가 있는 코드 (수정 필요)