程式碼提供的參數和資訊

aobaochiai

程式碼提供的參數和資訊

這是我與AI工具的對話, 或許可以給想要"操控AI工具"的初學同好做一參考! 有成效最好, 沒有就當我的學習心得!!

我的問:   請問,如果要請你幫忙寫編碼,我要提供那些參數?

AI的答:   
我來幫你歸納一下「讓我幫忙寫程式」時，最好一次就給齊的 6 大類參數。只要照這個清單提供，我通常就能直接產出可運行、符合你需求的程式碼，後續來回修改的次數會少很多。
________________________________________
1. 目標語言與版本
•        指定語言：Python、JavaScript、C# …
•        指定版本：Python 3.11、Node 20、.NET 8 …
•        若有框架：Spring Boot 3、React 18、Django 4.2 …
範例：
「請用 Python 3.11 + FastAPI 0.110」
________________________________________
2. 功能需求（一句話 + 要點條列）
•        一句話總結：「做一個把 CSV 轉 JSON 的 CLI 工具」
•        要點條列：
o        支援欄位對映檔（YAML）
o        可過濾空值列
o        輸出縮排 2 空格
o        需要單元測試
________________________________________
3. 輸入與輸出規格
•        輸入：檔案格式、編碼、最大 size、範例檔或 schema
•        輸出：格式、編碼、範例、是否需壓縮、下載方式
範例：
「輸入是 GBK 的 CSV，第一列是欄位名，日期欄位格式 2024/05/06；輸出 UTF-8 的 JSON Array，每筆物件要有原始檔名與 rowNumber」
________________________________________
4. 邊界條件與錯誤處理
•        空檔、超大型檔、欄位缺失、格式錯誤、網路中斷…
•        希望行為：拋例外、回錯誤碼、寫 log、跳過並計數…
範例：
「缺欄位時直接跳過該列，並把 rowNumber 寫到 error.log，最後回報總錯誤數」
________________________________________
5. 執行環境與相依限制
•        OS：Windows / Linux / macOS / Docker
•        相依套件：只能用標準庫？能否 pip install？公司 Nexus 鏡像？
•        硬體限制：記憶體 < 512 MB、無 GPU、ARM64…
•        安全限制：禁止對外連線、不能用 GPL 套件…
________________________________________
6. 交付物與風格規範
•        交付物：單一檔案、模組、Dockerfile、測試腳本、Git repo…
•        命名規則、編碼風格（PEP8、Google Java Style…）
•        註解語言：中文 / 英文
•        需不需要日誌、log level、是否用 logging 框架
•        需不需要 CLI 參數說明（argparse、click、docopt…）
________________________________________
快速模板（直接複製填空）
Markdown
代码预览
1. 語言/版本：_______________  
2. 功能一句話：_______________  
3. 輸入規格：  
   - 格式：_______________  
   - 編碼：_______________  
   - 範例：_______________  
4. 輸出規格：  
   - 格式：_______________  
   - 範例：_______________  
5. 邊界/錯誤：_______________  
6. 環境限制：  
   - OS：_______________  
   - 相依：_______________  
   - 記憶體/網路：___________  
7. 交付物：  
   - 檔案/模組/測試：_______  
   - 風格/註解語言：________  
________________________________________
小結
把上面 6 大類、十幾個空格一次填好，我就能「一輪」產出貼近落地的程式碼；若還有介面截圖、範例檔、偽代碼，直接貼上來更能節省時間。

僅供學習參考