From 9467b8c87f5e35792ebd9dd9d0eba43b4a2a8ac3 Mon Sep 17 00:00:00 2001 From: JiWoong Sul Date: Mon, 29 Sep 2025 18:09:44 +0900 Subject: [PATCH] =?UTF-8?q?=ED=85=8C=EC=8A=A4=ED=8A=B8=20=EC=A3=BC?= =?UTF-8?q?=EC=84=9D=ED=99=94=20=EA=B3=84=ED=9A=8D=20=EB=AC=B8=EC=84=9C=20?= =?UTF-8?q?=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/commenting_plan.md | 3 +++ doc/test_commenting_plan.md | 27 +++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 doc/test_commenting_plan.md diff --git a/doc/commenting_plan.md b/doc/commenting_plan.md index 9f96cef..354f3ce 100644 --- a/doc/commenting_plan.md +++ b/doc/commenting_plan.md @@ -44,5 +44,8 @@ - 대용량 파일(>400 LOC)은 주석보다 구조 분리를 우선 검토. ## 인벤토리 모듈 주석화 자세한 일정과 적용 파일은 doc/inventory_commenting_plan.md 참고 + +## 테스트 주석화 +세부 계획은 doc/test_commenting_plan.md 참고 ## Core/Widgets 주석화 세부 계획은 doc/core_commenting_plan.md 참고 diff --git a/doc/test_commenting_plan.md b/doc/test_commenting_plan.md new file mode 100644 index 0000000..2c2cdd0 --- /dev/null +++ b/doc/test_commenting_plan.md @@ -0,0 +1,27 @@ +# 테스트 주석화 계획 + +| 테스트 파일 | 주석 방향 | +|--------------|----------------| +| test/core/permissions/permission_manager_test.dart | 주요 기능 테스트 목표 및 검증 범위 | +| test/features/approvals/history/presentation/controllers/approval_history_controller_test.dart | 주요 기능 테스트 목표 및 검증 범위 | +| test/features/approvals/presentation/controllers/approval_controller_test.dart | 주요 기능 테스트 목표 및 검증 범위 | +| test/features/approvals/step/presentation/controllers/approval_step_controller_test.dart | 주요 기능 테스트 목표 및 검증 범위 | +| test/features/approvals/template/presentation/controllers/approval_template_controller_test.dart | 주요 기능 테스트 목표 및 검증 범위 | +| test/features/masters/customer/presentation/controllers/customer_controller_test.dart | 주요 기능 테스트 목표 및 검증 범위 | +| test/features/masters/group/presentation/controllers/group_controller_test.dart | 주요 기능 테스트 목표 및 검증 범위 | +| test/features/masters/group_permission/presentation/controllers/group_permission_controller_test.dart | 주요 기능 테스트 목표 및 검증 범위 | +| test/features/masters/menu/presentation/controllers/menu_controller_test.dart | 주요 기능 테스트 목표 및 검증 범위 | +| test/features/masters/product/presentation/controllers/product_controller_test.dart | 주요 기능 테스트 목표 및 검증 범위 | +| test/features/masters/user/presentation/controllers/user_controller_test.dart | 주요 기능 테스트 목표 및 검증 범위 | +| test/features/masters/vendor/presentation/controllers/vendor_controller_test.dart | 주요 기능 테스트 목표 및 검증 범위 | +| test/features/masters/warehouse/presentation/controllers/warehouse_controller_test.dart | 주요 기능 테스트 목표 및 검증 범위 | + +## 우선 적용 +1. 결재/인벤토리 컨트롤러 테스트 +2. 마스터 관리 컨트롤러 테스트 +3. 공통 위젯/유틸 테스트 + +## 주석 작성 원칙 +- 시나리오별로 // 주석으로 목적/검증 포인트 요약 +- Mock/Stub 선언부에는 /// Doc 주석으로 역할 설명 +- 공통 헬퍼 함수에는 /// Doc 주석 작성