Feature: 컴포넌트 네이밍 및 기능 주석 개선

[ehlung]

어떤 기능인가요?

현재 컴포넌트 파일들의 이름이 명확하지 않고, 컴포넌트 내부 기능에 대한 주석이 부족하여 코드 가독성과 유지보수성이 떨어지는 문제를 해결하고자 합니다.
컴포넌트의 역할과 기능을 명확하게 정의하여 다른 개발자가 코드를 쉽게 이해하고 수정할 수 있도록 개선하는 작업입니다.

작업 상세 내용

• 컴포넌트 역할이 명확히 드러나도록 이름 변경
• 컴포넌트 파일 상단에 기능 요약 주석 추가
  • 각 컴포넌트가 어떤 역할을 하는지 2-3줄의 간결한 주석으로 설명
  • props로 전달받는 데이터가 무엇인지, 컴포넌트가 어떤 상태를 관리하는지 명시
• 복잡한 로직 및 함수에 주석 추가:
  • useEffect, API 호출 함수 등 로직의 흐름을 파악하기 어려운 부분에 주석을 달아 이해를 도움
• 기존 컴포넌트 사용처의 import 경로 및 이름 변경 적용:
  • 컴포넌트 이름 변경 후, 해당 컴포넌트를 사용하는 모든 파일에서 import 구문을 수정하여 에러가 발생하지 않도록 유의

참고할만한 자료(선택)