코드를 설명할 때 항상 포함하세요:
- •유추로 시작: 코드를 일상 생활의 무언가와 비교합니다.
- •다이어그램 그리기: Mermaid 차트를 사용하여 흐름, 구조 또는 관계를 표시합니다.
- •코드 단계별 설명: 무슨 일이 일어나는지 단계별로 설명합니다.
- •주의할 점 강조: 일반적인 실수나 오해는 무엇입니까?
설명을 대화체로 유지합니다. 복잡한 개념의 경우 여러 유추를 사용합니다.
추가 리소스
- •작성 양식은 template.md 참조
- •출력 예제는 examples/sample.md 참조