PHP 擴充開發檢測清單

這篇文章介紹的內容是關於PHP 擴充開發檢測清單，有著一定的參考價值，現在分享給大家，有需要的朋友可以參考一下

想要做出一個成功的PHP 擴充包，不只是簡單的將程式碼放進資料夾就可以了，除此之外，還有非常多的因素來決定你的擴充功能是否優秀。以下清單的內容將有助於完善你的擴展，並且在 PHP 社群中得到更多的重視。

1. 為你的擴充選擇一個正確合適的名字

• #確保你的命名沒有被其他項目使用。

• 擴充的名字需要和你的 PHP 命名空間保持一致。

• 不要在你的命名空間中使用自己的姓名或其他帶有個人色彩的東西。

2. 將你的擴充開源

• #GitHub 可以免費管理這一類公共的專案。

• GitHub 非常有助於你來管理這個開源項目，並且方便他人取得你的擴充功能。

• 如果你不想使用，可以嘗試替代品: Bitbucket.

3. 對自動載入友善一些

• 使用PSR-4 相容的自動載入器命名空間。

• 請將程式碼放在 src 資料夾裡。

4. 透過Composer 發布

• #確保可以透過Composer 來找到你的類別庫，  Composer 是PHP的一個依賴管理工具

• 發佈在Packagist上，Packagist 是一個主要的Composer 套件倉庫。

5. 不限於框架

• 不要侷限於項目只能使用在一個框架上。

• 透過服務提供器來給予框架特殊支援。

6. 遵循一種編碼風格

• ##你強烈建議你堅持使用 PSR-2 編碼風格。

• 使用程式碼自動格式化工具，例如 PHP Coding Standards Fixer 。

• 使用程式碼風格來偵測工具，例如 PHP Code Sniffer 。

7.  寫單元測試

• # 覆寫大部分的程式碼。

• 使用 PHPUnit ，一個常用的 PHP 單元測試框架。

• 其他可選： phpspec ， Behat ， atoum ， Codeception。

8. 為程式碼寫註解

• 將註解當作內建文件來看待。

• 程式碼註解也可以改善 IDE 的程式碼自動完成功能, 例如 PhpStorm 。

• 可以自動轉換成 API 文檔， 查看 phpDocumentor 。

9. 使用語意化版本管理

• #使用 語意化版本號 來管理版本號。

• 遵循 主版本.次版本.補丁版本 規格。

• 讓開發人員安全的升級軟體，而不用擔心會產生破壞性的改變。

• 請記得及時標記發布版本！

10.  維持定期更新日誌

• #明確標記並顯示版本之間顯著的變化。

• 考慮遵循 Keep a CHANGELOG 的格式進行編寫。

11. 使用持續整合

• 使用服務來自動檢查編碼是否標準並且能否通過執行測試。

• 在多個不同的 PHP 版本都執行測試會是個不錯的方法。

• 確保提交或拉取的時候都可以自動執行。

• 參考：Travis-CI，Scrutinizer, Circle-CI。

12. 撰寫大量的使用文件

• #一份優秀的文件對於擴充包來說至關重要。

• 至少要確保庫中有詳細的 README (自述) 檔案。

• 可以嘗試在 GitHub Pages　中託管文件。

• 可用參考： Read the Docs。

13.  包含一份授權（License）

• 包含一份授權協議，能夠有效地保護你的工作成果，並且很容易做到。

• 參考 choosealicense.com。大部分PHP 開源專案使用 MIT 協定。

• 至少要在程式碼庫中包含 LICENSE 檔案。

• 也可以考慮在 Docblocks 中加入你的授權協定。

14. 歡迎大家的貢獻

• #想要大家輔助改進項目，那一定要多請求大家的貢獻！

• 有一份 CONTRIBUTING 文件，列出貢獻者的名單。

• 利用這份文件解釋專案環境要求，例如測試環境。

更多現代化PHP 知識，請前往Laravel / PHP 知識社群

相關推薦：

##PHP擴充開發教學總結

php擴充開發#

以上是PHP 擴充開發檢測清單的詳細內容。更多資訊請關注PHP中文網其他相關文章！