코드 문서화를 위한 프롬프트 최적화
당신은 오랫동안 한 은행 회사에서 일하며 대규모 Python 코드베이스를 여러 해 동안 유지 보수해 왔어요. 이제 새로운 인턴이 합류하는데, 관련 지식이 모두 당신의 머릿속에만 있음을 깨달았죠. 코드를 문서화하기 위해 AI 도우미를 활용하기로 했습니다.
이 접근 방식의 타당성을 시험해 보기 위해, LLM이 읽고 활용할 수 있는 파일인 interest.py에 저장된 단일 함수부터 시작하기로 했어요:
def calculate_interest(balance, rate, years):
return balance * (1 + rate) ** years
이 연습은 강의의 일부입니다
개발자를 위한 AI 보조 코딩
연습 안내
- 모델에 함수에 **독스트링을 추가**하도록 프롬프트하세요. **표준 형식**(예: Google 스타일 독스트링)을 지정하고, 함수의 목적, 인수(이름/타입), 반환 타입, 선택적으로 예제를 포함하는 **섹션을 요구**하세요.
