iT邦幫忙

2025 iThome 鐵人賽

DAY 26
0

一、程式碼回顧與精簡

在開發過程中,經常會留下一些臨時測試用的程式碼、冗餘的註釋或不夠理想的變數命名。是時候進行重構 (Refactoring) 了:

  1. 優化命名:確保所有函式、類別和變數的名稱都具有描述性(例如,將 df 改為 tourist_data_df)。

  2. 刪除冗餘:移除所有不再需要的 print() 語句、多餘的測試區塊或棄用的函式。

  3. 遵守 PEP 8 規範:確保程式碼遵循 Python 的官方風格指南(例如:使用四個空格縮排、適當的空行間隔),這能大幅提升程式碼的可讀性和可維護性。

二、撰寫清晰的 README 文件

程式碼本身只是專案的一部分,一份清晰的 README.md 文件是專案的「使用手冊」和「門面」。這對於後續的分享、開源和交接至關重要。

README.md包含以下核心資訊:

  • 專案簡介:用一兩句話概括這個智慧旅遊助理的功能。

  • 系統架構:簡述使用了 LoRA、RAG 和 Function Calling 等哪些技術。

  • 安裝與運行:提供簡單、清晰的安裝步驟(例如:pip install -r requirements.txt)和啟動指令。


上一篇
【Day25】最終功能驗收 - 專案的壓力測試
下一篇
【Day27】總結 - 架構圖與技術回顧
系列文
智慧旅遊顧問--結合 LLM 與 RAG 架構的台灣旅遊資訊助手27
圖片
  熱門推薦
圖片
{{ item.channelVendor }} | {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言