AI Agents · 강의

코드 설명 에이전트

소스 파일을 읽고 LLM에 설명을 요청한 뒤 Markdown 문서를 반환하는 에이전트를 구축해보세요.

코드 설명 에이전트은(는) CoddyKit의 무료 AI Agents 강의입니다. 이것은 4개 중 2번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 AI Agents 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. AI Agents 강의에는 총 4개의 강의가 포함되어 있습니다.

이 강의의 일부는 아직 번역되지 않았으며 영어로 표시됩니다.

프로젝트 목표

소스 파일(Python, JS 등)을 받아 목적, 핵심 함수, 사용 예제를 포함한 Markdown 문서를 반환하는 에이전트를 구축합니다.

왜 유용할까요?

코드에서 문서를 생성하는 일은 가장 신뢰할 수 있는 LLM 활용 사례 중 하나입니다. 코드는 구조화되어 있고 작업 범위가 명확하며 출력물을 사람이 읽으므로 사소한 오류는 허용할 수 있습니다.

아키텍처

소스 파일 읽기
필요하면 클래스나 함수별로 나누기
각 청크마다 LLM에 설명을 요청하기
Markdown 문서 하나로 결합하기

Step 1: Read the File

import sys

with open('example.py', 'w') as f:
    f.write('print("hello")\n')

path = sys.argv[1] if len(sys.argv) > 1 else 'example.py'
with open(path) as f:
    code = f.read()
print(f'Read {len(code)} characters from {path}')

Step 2: Prompt for Documentation

from openai import OpenAI
oai = OpenAI()

prompt = f'''
You are a senior engineer writing developer-friendly docs.

Given this source file, produce a Markdown document with:
# {path}

## Purpose
(One paragraph)

## Public API
(Each function/class with one-line description)

## Usage Example
(One short, runnable snippet)

Source:
```
{code}
```
'''

response = oai.chat.completions.create(
    model='gpt-4o-mini',
    messages=[{'role': 'user', 'content': prompt}],
    temperature=0.2,
)
print(response.choices[0].message.content)

긴 파일 처리하기

파일이 너무 길다면 함수별로 나누고 각각을 따로 설명합니다:

import ast

tree = ast.parse(code)
functions = [node for node in ast.walk(tree) if isinstance(node, ast.FunctionDef)]

for func in functions:
    snippet = ast.unparse(func)
    explain(snippet)

3단계: 출력 결합하기

여러 청크를 실행할 때는 함수별 설명을 하나의 문서로 이어 붙입니다:

docs = []
for func_name, snippet in functions:
    explanation = explain(snippet)
    docs.append(f'### {func_name}\n\n{explanation}\n')

full_doc = '\n'.join(docs)
open('docs.md', 'w').write(full_doc)

프로젝트 수준 요약 추가하기

함수별 설명이 끝나면 LLM에 전체적인 개요를 요청합니다:

summary_prompt = 'Summarise the purpose of this package in 3 sentences, given these function docs:\n\n' + full_doc
summary = ask(summary_prompt)

여러 언어 지원

동일한 프롬프트를 JS, Go, Rust 등에도 사용할 수 있습니다. 더 나은 결과를 얻으려면 프롬프트에 언어를 추가합니다:

prompt = f'You are documenting {language} code. ...'

변경 사항 기반 문서

점진적으로 업데이트할 때는 변경된 파일만 다시 처리합니다:

import subprocess
changed = subprocess.check_output(['git', 'diff', '--name-only', 'HEAD~1']).decode().splitlines()
for path in changed:
    if path.endswith('.py'):
        regenerate_doc(path)

도구로 예제 실행하기

LLM이 작성한 사용 예제가 실제로 실행되는지 확인합니다. 에이전트에 Python REPL 도구를 제공합니다:

def run_python(code):
    try:
        exec(code, {})
        return {'stdout': 'ok', 'stderr': ''}
    except Exception as e:
        return {'stdout': '', 'stderr': str(e)}

tools = [{'name': 'run_python', 'description': 'Execute a Python snippet and return stdout/stderr', 'parameters': {'code': 'str'}}]

broken_example = 'print(1/0)'
result = run_python(broken_example)
if result['stderr']:
    print('Example failed:', result['stderr'])
    fixed_example = 'print(1)'
    result = run_python(fixed_example)
    print('Self-corrected result:', result)
else:
    print('Example ran fine:', result)

에이전트가 환각을 일으킬 때

모델이 함수나 인수를 지어내는 경우가 있습니다. 다음과 같이 완화할 수 있습니다:

파일 내용만 제공합니다(모델의 기억은 제공하지 않음)
온도를 0으로 설정합니다
검증 단계를 둡니다(예제를 실행하거나 코드 조각을 린트함)

제품으로 만들기

이를 CLI로 감쌉니다:

# pip install -e .
# docgen src/myproject/agent.py
# Outputs docs.md

도구에서 CI로

CI에 연결합니다. 모든 PR마다 변경된 파일의 문서를 다시 생성하여 저장소에 반영합니다. 이제 저장소의 문서가 항상 최신 상태로 유지됩니다.

전체 파일을 읽는 이유

함수 시그니처만 전달하지 않고 전체 소스 파일을 LLM에 전달하는 이유는 무엇일까요?

정리

코드를 문서로 바꾸는 30줄짜리 에이전트입니다. 도구와 검증 기능을 쉽게 확장할 수 있으며, RAG 다음에 진행하기 좋은 두 번째 프로젝트입니다.

자주 묻는 질문

“코드 설명 에이전트” 강의는 무료인가요?

네 — “코드 설명 에이전트” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 AI Agents 강의 전체를 잠금 해제할 수 있습니다. AI Agents 강의에는 총 4개의 강의가 포함되어 있습니다.

“코드 설명 에이전트”에서 뭘 배우나요?

소스 파일을 읽고 LLM에 설명을 요청한 뒤 Markdown 문서를 반환하는 에이전트를 구축해보세요. 브라우저에서 직접 실행하는 실습 코드로 AI Agents을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.

AI Agents을(를) 시작하는 데 경험이 필요한가요?

사전 경험은 필요하지 않습니다. CoddyKit의 AI Agents은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 2번째 강의입니다.

“코드 설명 에이전트” 강의는 얼마나 걸리나요?

대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.

이 AI Agents 강의에서 코드를 작성하고 실행할 수 있나요?

네. 모든 AI Agents 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.

이 강의의 모든 강의

← AI Agents(으)로 돌아가기