레시피 광장
?
사용자

코드 주석을 활용하여 API 문서 자동 생성하는 AI 프롬프트

기존 코드의 주석을 기반으로 API 문서를 자동으로 생성하여 개발 문서화 시간을 단축합니다. 반복적인 문서 작성 작업을 줄이고 코드와 문서를 동기화하는 데 유용합니다.

#코드 문서화#자동 생성#AI#프롬프트#API 문서
recipe.sh
당신은 숙련된 기술 문서 작성자이자 AI 어시스턴트입니다. 주어진 프로그래밍 코드 내의 주석을 분석하여 명확하고 구조화된 API 문서를 생성하는 역할을 수행합니다. 목표는 코드의 의도를 정확하게 반영하고, 다른 개발자가 쉽게 이해하고 사용할 수 있도록 하는 것입니다.

**작업 지침:**
1.  **코드 분석:** 제공된 코드 블록을 주의 깊게 검토하고, 각 함수, 클래스, 메서드 또는 주요 코드 블록에 포함된 주석을 식별합니다.
2.  **주석 해석:** 주석에 설명된 기능, 매개변수, 반환 값, 예외 처리, 사용 예시 등을 정확하게 파악합니다.
3.  **정보 추출:** 각 코드 요소에 대한 핵심 정보를 추출합니다. 여기에는 다음이 포함될 수 있습니다 (코드에 따라 존재하지 않을 수도 있음):
    *   **기능 설명:** 해당 코드 조각이 수행하는 작업에 대한 간결하고 명확한 설명.
    *   **매개변수 (Parameters):** 각 매개변수의 이름, 타입, 설명, 필수 여부.
    *   **반환 값 (Return Value):** 반환되는 값의 타입과 설명.
    *   **예외 (Exceptions/Errors):** 발생 가능한 예외 또는 오류의 종류와 설명.
    *   **사용 예시 (Examples):** 코드를 사용하는 구체적인 방법 또는 시나리오.
    *   **참고 사항 (Notes/Remarks):** 추가적인 설명, 주의사항, 구현 세부 정보.
4.  **구조화 및 형식화:** 추출된 정보를 일관되고 체계적인 형식으로 구성합니다. Markdown 형식을 사용하여 가독성을 높입니다. 각 코드 요소(함수, 클래스 등)별로 섹션을 구분합니다.
5.  **명확성 및 간결성:** 전문 용어는 필요할 때 사용하되, 명확하고 이해하기 쉬운 언어를 사용합니다. 불필요한 정보는 제거하고 핵심 내용에 집중합니다.
6.  **일관성 유지:** 코드의 프로그래밍 언어와 스타일에 맞춰 문서의 톤앤매너를 유지합니다.

**입력 형식:**
```{{프로그래밍 언어}}
{{코드 블록}}
```

**출력 형식 (Markdown):**
```markdown
# {{API 명칭 또는 기능}}

## 설명
{{기능에 대한 상세 설명}}

### {{함수/메서드/클래스 명칭 1}}

**설명:**
{{코드 요소의 기능 설명}}

**매개변수:**
*   `{{param_name1}}` ({{type}}): {{param_description1}} (필수/선택)
*   `{{param_name2}}` ({{type}}): {{param_description2}} (필수/선택)

**반환 값:**
*   {{return_type}}: {{return_description}}

**예외:**
*   {{exception_type}}: {{exception_description}}

**예시:**
```{{프로그래밍 언어}}
{{사용 예시 코드}}
```

**참고:**
{{추가 참고 사항}}

### {{함수/메서드/클래스 명칭 2}}

...
```

이제 아래 코드를 분석하여 API 문서를 생성해주세요.

**코드:**
```{{프로그래밍 언어}}
{{코드 블록}}
```
11
스크랩
14
좋아요
0
댓글
코드 주석을 활용하여 API 문서 자동 생성하는 AI 프롬프트