에이전트 활용 사례

오늘 등록된 사례

44전체 189건

189개 중 1–20개

개발·코딩구현 예제

파이썬 파일을 읽어 README와 함수 설명 초안 쓰기

함수와 클래스 구조를 읽고 사용 안내 문서와 설명을 덧붙인 파이썬 파일을 따로 만들어요.

사용법

  1. --file로 대상 파일을 지정하고 --format에서 readme, docstrings 또는 both를 선택해요.
  2. 프로그램이 함수와 클래스 구조를 추린 뒤 모델에 설치 방법, 사용 예제와 API 설명을 작성하게 해요. 함수 설명 모드에서는 전체 코드를 모델에 전달해요.
  3. 문서는 README_모듈명.md로, 설명을 덧붙인 코드는 documented_파일명으로 저장돼요. 원본 파일에 직접 덮어쓰는 방식은 아니에요.

결과

문서와 함수 설명이 들어간 파일을 생성하는 구현 예제예요. 생성한 코드의 동작 보존이나 문서 속 예제를 자동 검증하지는 않아요.

참고사항

README를 만들 때 모델에 전달하는 코드 본문은 처음 3000자로 제한돼 있어요. 긴 파일의 뒤쪽 동작이 문서에서 빠질 수 있어 별도 검토가 필요해요.

출처

GitHub 원문 ↗

예시 프롬프트 · LangChain

[Python 모듈]을 위한 README와 함수 설명 초안을 만들어 주세요. agents/16-documentation-writer의 구조 추출과 문서 생성 코드를 참고하고 Python 환경과 모델 API 설정을 정리합니다. 결과는 [비어 있는 출력 폴더]에 저장하세요.

실제 함수 이름, 입력값, 반환값과 예외를 코드에서 확인해 설명하고 공개되지 않은 설치 명령이나 환경변수를 만들지 마세요. 원문의 README 경로는 코드 본문을 3000자까지만 전달하므로 긴 파일은 빠진 구간이 없는지 확인하고 나누어 읽도록 보완합니다. 설명이 추가된 코드는 원본과 별도 파일로 두세요.

동기·비동기 함수, 기본값과 예외가 있는 작은 모듈로 검사합니다. 문서 속 예제를 작업 사본에서 실행하고 함수 설명 이외에 동작이 달라지지 않았는지 원본과 비교하세요. 결과물은 README, 설명을 추가한 파일, 변경 비교와 실행 기록입니다. 아직 실행하지 않은 사용 예제를 검증 완료로 적지 말고, 이번에 보완한 긴 파일 처리와 검증 범위를 구분해 주세요.