결재/인벤토리 주석화 1단계 및 계획 문서 추가
This commit is contained in:
19
doc/inventory_commenting_plan.md
Normal file
19
doc/inventory_commenting_plan.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# 인벤토리 모듈 주석화 계획
|
||||
|
||||
## 적용 대상
|
||||
- 입고 페이지: `lib/features/inventory/inbound/presentation/pages/inbound_page.dart`
|
||||
- 출고 페이지: `lib/features/inventory/outbound/presentation/pages/outbound_page.dart`
|
||||
- 대여 페이지: `lib/features/inventory/rental/presentation/pages/rental_page.dart`
|
||||
- 상품 자동완성 위젯: `lib/features/inventory/shared/widgets/product_autocomplete_field.dart`
|
||||
|
||||
## 우선 적용 순서
|
||||
1. 입고 화면(페이지/공유 위젯)
|
||||
2. 출고 화면
|
||||
3. 대여 화면
|
||||
|
||||
## 주석 작성 원칙
|
||||
- 주요 위젯/State 클래스에 `///` 주석으로 역할과 핵심 동작 설명
|
||||
- 복잡한 검증/상태 변경에는 `//` 주석으로 근거 추가
|
||||
- 기존 코드 스타일 유지(영문 변수명 유지, 주석만 한글)
|
||||
- 주석 추가 후 `dart format`, `flutter analyze`, `flutter test`로 검증
|
||||
|
||||
Reference in New Issue
Block a user