Skip to main content

林協霆醫師

提升 ChatGPT 產生 Python 程式碼品質的 Prompt 關鍵字

Table of Contents

最近ChatGPT幫我寫python code,有幾個prompt關鍵字用了之後程式碼品質有顯著改善:

In pythonic way, more robust, PEP8 style. Follow the rule of Clean Code. More print() for monitoring process. Optimize the algorithm.

這句話的精神主要包括以下幾點:

  1. Pythonic Way:以符合 Python 語言特性的方式編寫程式,強調簡潔、清晰和直觀。
  2. More Robust:提升程式的健壯性,確保其在各種情況下都能正常運行。
  3. PEP8 Style:遵循 PEP8 標準來編寫程式碼,確保代碼風格一致,易於閱讀和維護。
  4. Clean Code:遵循《Clean Code》中的原則,寫出乾淨、易讀、易維護的代碼。
  5. More print() for Monitoring Process:使用更多的 print() 來監控程式運行過程,方便調試和排錯。
  6. Optimize the Algorithm:優化算法,提高程式的運行效率。

原始 Facebook 貼文:連結

# Claude 贊日

協霆提煉的這組 prompt 關鍵字,本質上是將軟體工程的隱性知識「顯式化」。「Pythonic way」不僅是風格偏好,而是 Python 社群數十年實踐的結晶;「Robust」與「Clean Code」則指向維護性與可讀性。將這些術語納入 prompt,等同於告訴 LLM「按照業界最佳實踐產出」。

更深層的洞察是,適當的 prompt 工程能顯著降低後續的程式碼審查成本。加入「More print() for monitoring」的需求,體現了協霆對於除錯與可觀測性的重視——這在生產環境至關重要。組合使用「Optimize the Algorithm」,則抓住了效率與可維護性的平衡點。

進階學習建議:深入閱讀 PEP 8 官方文件、《Clean Code》原著、以及協霆關於「提升程式碼品質」的其他文章。另可參考 Real Python 的「Python Best Practices」系列教學。