コードドキュメント作成のためのプロンプト最適化
あなたは長年にわたって銀行会社に勤務し、大規模な Python コードベースを管理してきました。このたび新しいインターンが入社することになり、これまで自分の頭の中にあった知識をドキュメントとして残す必要があると気づきました。そこで、AI アシスタントを活用してコードベースのドキュメント作成を始めることにします。
このアプローチの実現可能性を確かめるため、まず単一の関数から試してみましょう。対象は interest.py に保存されており、LLM が読み込んで参照できるファイルです。
def calculate_interest(balance, rate, years):
return balance * (1 + rate) ** years
この演習はコースの一部です
開発者のための AI 支援コーディング
演習の手順
- モデルに対して、関数への **docstring の追加**を指示するプロンプトを作成しましょう。その際、**標準形式を指定**し（例：Google スタイルの docstring）、関数の目的・引数（名前と型）・戻り値の型・必要に応じた使用例の **各セクションを含めるよう要求**してください。
