claude

클로드 코드 문서화 프롬프트 - 주석 작성 README API 문서

Claude로 코드 문서화, 주석 작성, README 작성, API 문서를 생성하는 프롬프트입니다. JSDoc, Docstring, 기술 문서화 표준을 따릅니다.

수정 2026년 9월 6일

#코드문서화 #주석작성 #README #API문서 #JSDoc #Docstring

💡

프롬프트 사용 방법

1단계: 아래 입력 칸에 각 항목에 맞는 정보를 적어주세요
2단계: 입력하면 아래 프롬프트가 자동으로 업데이트됩니다
3단계: '프롬프트 복사' 버튼을 눌러 ChatGPT/Claude에 붙여넣으세요

💡 입력 칸의 회색 글씨는 예시입니다. 참고해서 작성해보세요!

📝 필요한 정보를 입력해주세요 (총 5개)

코드 (코드)

분석할 코드

프로그래밍 언어 (언어)

사용 언어

범위 (범위)

범위에 대한 값을 입력하세요

독자 (독자)

독자에 대한 값을 입력하세요

문서 스타일 (문서_스타일)

문서 스타일에 대한 값을 입력하세요

📋 완성된 프롬프트 (복사해서 사용하세요)

당신은 구글 테크니컬 라이팅 팀 출신 문서화 전문가입니다. 10년간 오픈소스 프로젝트 문서를 작성해 온 전문가로서 개발자를 위한 명확한 문서를 작성해 주세요.


## 문서화할 코드
```
{{코드}}
```

## 컨텍스트
- 언어: {{언어}}
- 범위: {{범위}}
- 독자: {{독자}}
- 스타일: {{문서_스타일}}

## 문서화 요구사항

### 함수/메서드
- 요약 (한 줄), 파라미터, 반환값, 예외, 예제 2-3개

### 클래스
- 목적, 주요 속성, Public 메서드, 사용 예제

### README.md
- 제목, 개요, 기능, 설치, 사용법, 기여, 라이선스

### API 문서
- 엔드포인트, 파라미터, 요청/응답 예시, 에러 코드

## 품질 기준
- 명확성: 모호한 표현 피하기
- 완결성: 모든 파라미터/반환값 설명
- 예제 중심: 실행 가능한 코드 제공
```

## 간단 버전

```text
다음 {{언어}} 코드에 {{문서_스타일}} 스타일 주석을 추가해주세요:

```
{{코드}}
```

포함: 함수 요약, 파라미터, 반환값, 예제 2개

입력하지 않은 항목은 원래 표시를 유지합니다.

입력값 가이드

아래 5개의 항목을 입력하면 맞춤형 코드 문서화 가이드를 제공해 드립니다.

입력 항목	한국어 설명	placeholder	예시
코드	문서화할 코드를 복사해서 붙여넣어 주세요	코드를 여기에 붙여넣기	`def process_data(data): ...`, `function calculate() {...}`
언어	사용 중인 프로그래밍 언어를 적어주세요	Python 선택	`Python`, `TypeScript`, `Java`, `Go`, `Rust`
범위	어떤 종류의 문서가 필요한지 선택해 주세요	함수 주석 선택	`함수 주석`, `README`, `API 문서`, `클래스 문서`
독자	문서를 읽을 대상이 누구인지 알려주세요	입문자 선택	`입문자`, `경력 개발자`, `외부 사용자`, `팀원`
문서 스타일	선호하는 주석/문서화 스타일을 적어주세요	Google Docstring 선택	`JSDoc`, `Google Docstring`, `Javadoc`, `reStructuredText`

인풋 필드

[코드]
▼ 텍스트 영역 입력
placeholder: "코드를 여기에 붙여넣기"
설명: 문서화할 코드를 복사해서 붙여넣어 주세요

[언어]
▼ 드롭다운 선택
옵션: Python, JavaScript, TypeScript, Java, Go, Rust, C#, PHP
placeholder: "Python"
설명: 사용 중인 프로그래밍 언어를 적어주세요

[범위]
▼ 드롭다운 선택
옵션: 함수 주석, README, API 문서, 클래스 문서, 모듈 문서
placeholder: "함수 주석"
설명: 어떤 종류의 문서가 필요한지 선택해 주세요

[독자]
▼ 드롭다운 선택
옵션: 입문자, 경력 개발자, 외부 사용자, 팀원, 기술 담당자
placeholder: "입문자"
설명: 문서를 읽을 대상이 누구인지 알려주세요

[문서 스타일]
▼ 드롭다운 선택
옵션: Google Docstring, JSDoc, Javadoc, reStructuredText, Go Doc, rustdoc
placeholder: "Google Docstring"
설명: 선호하는 주석/문서화 스타일을 적어주세요

언어별 문서화 스타일

언어	스타일	예시
Python	Google Docstring	`Args:`, `Returns:`, `Raises:`
JavaScript/TS	JSDoc	`@param`, `@returns`, `@throws`
Java	Javadoc	`@param`, `@return`, `@throws`
Go	Go Doc	함수명으로 시작하는 문장
Rust	rustdoc	`///` 또는 `//!`

문서화 예시

Python (Google Style)

def fetch_users(limit: int = 10) -> List[User]:
    """
    사용자 목록을 가져옵니다.

    Args:
        limit: 반환할 최대 사용자 수 (1-100)

    Returns:
        User 객체 리스트

    Raises:
        ValueError: limit이 범위를 벗어날 때
    """

TypeScript (JSDoc)

/**
 * 사용자 인증을 처리합니다.
 * @param credentials - 인증 정보
 * @returns 인증 결과 (토큰, 사용자 정보)
 * @throws AuthenticationError 인증 실패시
 */
async function authenticate(credentials: Credentials): Promise<AuthResult>

자동화 도구

언어	도구	명령어
Python	Sphinx	`sphinx-apidoc -o docs src/`
TypeScript	TypeDoc	`typedoc --out docs src`
Java	Javadoc	`javadoc -d docs src/`
Go	godoc	`godoc -http=:6060`
Rust	rustdoc	`cargo doc --open`

주의사항

주의점	설명
보안	API 키, 비밀번호는 예시만 사용
동기화	코드 변경 시 문서도 업데이트
실행 가능	모든 예제는 실제 동작해야 함

🚀 AI 바로 열기

ChatGPT 열기 Claude 열기 Gemini 열기

🔗 관련 프롬프트

claude 수정 2026년 9월 6일

클로드 API 문서 작성 프롬프트 - 개발자용 기술 문서

Claude로 REST API, GraphQL API 문서를 작성하는 프롬프트입니다. 엔드포인트, 파라미터, 응답 예시, 에러 코드까지 완벽한 API 문서를 체계적으로 작성할 수 있습니다.

API문서기술문서

프롬프트와 사용 가이드

claude 수정 2026년 9월 6일

클로드 기술 문서 작성 프롬프트 - API 문서, 매뉴얼, 가이드

Claude로 개발자 친화적인 기술 문서를 작성하는 프롬프트입니다. API 문서, 사용자 매뉴얼, 개발자 가이드, README 등을 체계적으로 작성합니다.

기술문서API문서

프롬프트와 사용 가이드

claude 수정 2026년 9월 6일

클로드 API 개발 프롬프트 - RESTful API 설계 및 구현 가이드

Claude로 RESTful API를 설계하고 구현하는 개발 프롬프트입니다. API 엔드포인트 설계, 요청/응답 스키마 정의, 인증/보안 구현, 에러 처리, API 문서화 등 전체 API 개발 라이프사이클을 지원합니다.

API개발RESTful

프롬프트와 사용 가이드

claude 수정 2026년 9월 6일

MCP 도구 권한 검토 프롬프트: 최소 접근과 사용자 확인 경계

제공된 MCP 도구 정의와 업무 목적을 비교해 필요한 읽기 범위, 불필요한 쓰기 권한, 사용자 확인 항목을 정리하는 Claude 가이드입니다. 설명과 실제 권한 집행을 구분하고 자격 증명을 조회하지 않습니다.

MCP도구권한

프롬프트와 사용 가이드