diff --git a/doc/commenting_plan.md b/doc/commenting_plan.md index 192e222..9f96cef 100644 --- a/doc/commenting_plan.md +++ b/doc/commenting_plan.md @@ -44,3 +44,5 @@ - 대용량 파일(>400 LOC)은 주석보다 구조 분리를 우선 검토. ## 인벤토리 모듈 주석화 자세한 일정과 적용 파일은 doc/inventory_commenting_plan.md 참고 +## Core/Widgets 주석화 +세부 계획은 doc/core_commenting_plan.md 참고 diff --git a/doc/core_commenting_plan.md b/doc/core_commenting_plan.md new file mode 100644 index 0000000..c4c3487 --- /dev/null +++ b/doc/core_commenting_plan.md @@ -0,0 +1,26 @@ +# Core/Widgets 주석화 계획 + +## 대상 모듈 (1차) +| 우선순위 | 파일 | 주석 필요 위치 | +|----------|------|----------------| +| 1 | `lib/core/network/api_client.dart` | API 호출, 에러 매핑, 인터셉터 연결 | +| 1 | `lib/core/network/api_error.dart` | 에러 모델/매퍼 설명 | +| 1 | `lib/core/permissions/permission_manager.dart` | 권한 검사/Scope 동작 | +| 2 | `lib/core/config/environment.dart` | env 초기화 흐름, 추가 설명 필요시 | +| 2 | `lib/core/theme/superport_shad_theme.dart` | 테마 팩토리 설명 | +| 2 | `lib/core/routing/app_router.dart` | 라우터 설정 요약 | +| 3 | `lib/widgets/components/**` (이미 일부 주석 있음) | 추가 주석 대상 확인 | + +## 진행 순서 +1. `core/network` → `core/permissions` +2. `core/theme`, `core/routing`, `core/config` +3. 추가 위젯/공통 컴포넌트 재검토 + +## 작성 원칙 +- 퍼블릭 API, 초기화 로직, 복잡한 흐름 중심으로 `///` Doc 주석 작성 +- `//` 한 줄 주석은 로직 분기 / 예외 처리 근거에만 사용 +- 주석 추가 후 `flutter analyze`, `flutter test` + +## 산출물 +- 파일별 주석 적용 커밋 +- 계획 문서(`doc/core_commenting_plan.md`) 유지 보수