16강. 코드 포트폴리오 정리: 전체 코드 대신 설계와 핵심 구현을 설명하기

?1. 이번 강의에서 해결할 문제

긴 소스 파일을 그대로 붙이면 핵심 설계와 문제 해결 지점을 찾기 어렵습니다. 대표 클래스·모듈 두세 개를 골라 책임, 입력·출력과 선택 이유를 설명합니다.

✓2. 학습 목표

✓이번 강의를 마치면

• 프로젝트 가치를 만드는 핵심 코드 두세 곳을 선택합니다.
• 각 모듈의 책임과 데이터 흐름을 설명합니다.
• 짧은 코드 조각을 실제 파일과 테스트 근거에 연결합니다.

◇3. 핵심 개념

코드 포트폴리오는 문법 전시가 아니라 설계 판단의 안내서입니다. 문제 → 책임 분리 → 핵심 인터페이스 → 결과 → 테스트를 설명하고 전체 구현은 저장소 상대 링크로 제공합니다.

✎4. 단계별 실습

문서 작업 · 산출물: <PROJECT_ROOT>/docs/code-tour.md

docs/code-tour.md

# 핵심 코드 투어

### 1. 입력 검증 모듈
- 책임: 외부 입력을 규칙 계층이 사용할 안전한 값으로 변환
- 입력/출력: 원시 문자열 → 검증된 값 또는 오류
- 선택 이유: 규칙 코드가 UI·콘솔 형식에 의존하지 않게 분리
- 실제 위치: `src/실제-상대-경로`
- 검증: T-03 잘못된 입력, T-04 빠른 반복

### 2. 규칙·상태 모듈
- 책임: 성공·실패 판정과 상태 변경
- 협력 대상: 입력 모듈, 표시 모듈
- 하지 않는 일: 화면 요소 직접 탐색·갱신

## 데이터 흐름
입력 어댑터 → 검증 → 규칙 → 상태 이벤트 → UI·콘솔 출력

코드 작업 · 파일 경로: 프로젝트의 실제 핵심 파일

설명할 코드 조각의 기준

1. 15~30줄 안에서 하나의 판단을 보여 준다.
2. 앞뒤 문맥과 실제 상대 경로를 적는다.
3. 입력, 반환값·상태 변화와 실패 처리를 설명한다.
4. 전체 소스는 저장소 링크로 연결한다.

Unity는 Component·이벤트·ScriptableObject 책임, 웹은 데이터·DOM·이벤트 경계, Python·Java는 입력·도메인·출력 모듈 경계를 선택할 수 있습니다.

완료 기준: 핵심 코드 2개 이상에 책임, 입력·출력, 선택 이유, 실제 상대 경로와 테스트 ID가 있습니다.

§5. 작성 방식이 필요한 이유

작은 코드 조각과 맥락은 독자가 판단을 이해한 뒤 전체 구현을 탐색하게 합니다. 전체 코드를 복사해 문서를 오래되게 만들거나 중요한 부분을 묻히는 문제도 줄입니다.

!6. 자주 하는 실수와 해결법

!자주 하는 실수

• 가장 복잡한 코드를 선택: 프로젝트 가치를 만드는 책임 경계를 고릅니다.
• 전체 파일을 붙여넣음: 15~30줄과 실제 파일 링크만 사용합니다.
• 문법만 설명: 문제, 선택과 검증 결과를 중심으로 씁니다.
• 팀원의 핵심 코드를 내 구현처럼 설명: 작성자와 본인 변경 범위를 명시합니다.

✎7. 직접 실습

✎직접 실습

docs/code-tour.md에 핵심 클래스·모듈 2~3개를 정리하세요. 완료 기준은 처음 보는 사람이 데이터 흐름을 따라가고, 각 코드가 왜 분리됐는지와 어떤 테스트가 보호하는지 설명할 수 있는 것입니다.

?8. 이해 점검 질문 3개

?이해 점검

1. 전체 코드보다 짧은 조각과 맥락이 유용한 이유는 무엇인가요?
2. 핵심 코드를 선택할 때 복잡도보다 먼저 볼 것은 무엇인가요?
3. 코드 설명에 테스트 ID를 연결하면 어떤 장점이 있나요?

■9. 핵심 요약

■핵심 요약

핵심 코드 포트폴리오는 책임, 데이터 흐름과 선택 이유를 보여 줍니다. 짧은 실제 코드와 상대 경로, 검증 결과를 연결하고 전체 코드를 문서에 복사하지 않습니다.