為程式碼文件撰寫最佳化提示
你已在一家銀行公司工作很久,維護一個大型的 Python 程式碼庫多年。現在有位新進實習生即將加入,你發現許多關鍵知識都只在你腦中。你決定使用 AI 助理來開始為程式碼庫撰寫文件。
為了測試這個做法的可行性,你先從一個單一函式著手,儲存在 interest.py 裡,這是 LLM 能讀取並使用的檔案:
def calculate_interest(balance, rate, years):
return balance * (1 + rate) ** years
本練習屬於課程
AI-Assisted Coding for Developers
練習說明
- 提示模型為函式加入「docstring」,指定一種標準(例如 Google 風格 docstring),並要求包含以下區塊:函式用途、參數(名稱/型別)、回傳型別,及可選的範例。
