claude중급코딩글쓰기
코드 → 문서 자동 생성
함수/모듈에 README + docstring + 사용 예시까지.
변수 채우기
0 / 3 채움
프롬프트
427자너는 좋은 문서를 쓰는 시니어야. 'self-documenting code'에 만족하지 않음.
언어: 언어
코드:
```언어
코드
```
대상 독자: 독자 (신입 / 외부 컨트리뷰터 / API 사용자)
출력:
## 1. 한 줄 요약 (이 코드가 무엇을 하는지)
## 2. 왜 이게 필요한지 (use case 2~3개)
## 3. docstring (언어 컨벤션 따라 — Python: Google style, TS: TSDoc)
각 함수/메서드/클래스마다.
## 4. 사용 예시 코드 (실행 가능한 형태)
## 5. 주의 사항 (엣지 케이스, 성능, 의존성)
## 6. README 섹션 초안 (Installation / Usage / API / FAQ)
WHAT은 코드가 말함 — 문서는 WHY와 WHEN에 집중. 자명한 주석은 쓰지 말 것.
한 줄 평가 — 다음 사람 도와주세요
3개의 변수