주석화 진행상황 정리하고 핵심 모듈에 한글 주석 추가

This commit is contained in:
JiWoong Sul
2025-09-29 19:39:35 +09:00
parent 9467b8c87f
commit 47c87dc118
82 changed files with 596 additions and 5 deletions

View File

@@ -49,3 +49,13 @@
세부 계획은 doc/test_commenting_plan.md 참고
## Core/Widgets 주석화
세부 계획은 doc/core_commenting_plan.md 참고
### 진행 현황 메모
- [x] `responsive.dart` 단말 분기/가시성 헬퍼 주석 추가
- [x] `feedback.dart` 토스트·스켈레톤 메서드 용도 설명 보강
- [x] `form_field.dart` 필수/에러/캡션 속성 주석화
- [x] `lib/features/approvals` 컨트롤러/페이지/공유 위젯 주석 보강
- [x] `lib/features/approvals/data/**` 원격 저장소·DTO 변환 로직 주석화
- [x] `lib/features/inventory` 공유 카탈로그/자동완성 위젯 주석 보강
- [x] `lib/features/reporting` 보고서 페이지 필터/상태 주석 보강
- [x] `lib/features/masters/**` DTO/Repository/Controller/Page 주석 보강

View File

@@ -5,12 +5,34 @@
|----------|------|----------------|
| 1 | `lib/core/network/api_client.dart` | API 호출, 에러 매핑, 인터셉터 연결 |
| 1 | `lib/core/network/api_error.dart` | 에러 모델/매퍼 설명 |
| 1 | `lib/core/network/interceptors/auth_interceptor.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/**` (이미 일부 주석 있음) | 추가 주석 대상 확인 |
## 진행 현황
- [x] `lib/core/network/interceptors/auth_interceptor.dart` 토큰 갱신/재시도 흐름 문서화
- [x] `lib/core/services/token_storage.dart` 토큰 저장/초기화 Doc 주석 보강
- [x] `lib/core/permissions/permission_manager.dart` 오버라이드 처리/Scope 조회 주석 추가
- [x] `lib/core/config/environment.dart` 권한 맵 로딩/조회 인라인 설명 보강
- [x] `lib/core/theme/superport_shad_theme.dart` 라이트/다크 컬러 스킴 및 상태 배지 설명 추가
- [x] `lib/core/routing/app_router.dart` ShellRoute 구조와 라우트 명세 주석화
- [x] `lib/widgets/components/superport_table.dart` 정렬/페이지네이션 모델 설명 및 fromCells 생성자 주석 추가
- [x] `lib/widgets/components/superport_dialog.dart` show 헬퍼 주석, 편의 함수 한글 설명 갱신
- [x] `lib/widgets/components/filter_bar.dart` 버튼 활성 상태 게터 주석 보강
- [x] `lib/widgets/components/keyboard_shortcuts.dart` 다이얼로그 키보드 단축키 역할 설명 추가
- [x] `lib/widgets/components/responsive.dart` 분기 헬퍼/레이아웃 위젯 주석 추가
- [x] `lib/widgets/components/feedback.dart` 토스트·스켈레톤 메서드 용도 설명
- [x] `lib/widgets/components/form_field.dart` 필드 속성/멀티라인 설정 주석화
## 남은 작업 (Tasks)
- [x] `lib/widgets/components/responsive.dart` 전역 함수/클래스에 환경별 역할 Doc 주석 추가
- [x] `lib/widgets/components/feedback.dart` 토스트/스켈레톤 정적 메서드 용도 요약 (필요 시 예시 포함)
- [x] `lib/widgets/components/form_field.dart` 필수/유효성 문구 속성 설명 재검토(다단 필드 지원 여부 언급)
- [x] 주석화 완료 파일 재검토 후 동일 패턴으로 `doc/commenting_plan.md`에 반영 여부 확인
## 진행 순서
1. `core/network``core/permissions`
2. `core/theme`, `core/routing`, `core/config`