ホームページ >バックエンド開発 >PHPチュートリアル >PHP 拡張機能開発チェックリスト
PHP 拡張機能開発チェックリスト
- 不言オリジナル
- 2018-04-23 11:19:131202ブラウズ
この記事では、特定の参考値を備えた PHP 拡張機能開発チェックリストを紹介します。必要な友人はそれを参照してください
PHP 拡張機能パッケージを成功させたい場合は、次のようなものがあります。コードをフォルダーに入れるだけではなく、拡張機能が優れているかどうかを決定する多くの要素が考慮されます。次のチェックリストは、拡張機能を磨き、PHP コミュニティでより多くの注目を集めるのに役立ちます。
1. 拡張機能に正しく適切な名前を選択してください
あなたの名前が他のプロジェクトで使用されていないことを確認してください。
拡張機能の名前は、PHP 名前空間と一致している必要があります。
名前空間では自分の名前やその他の個人的なものを使用しないでください。
2. 拡張機能をオープンソースにする
GitHub はこの種の公開プロジェクトを無料で管理できます。
GitHub は、このオープンソース プロジェクトを管理し、他の人が拡張機能を簡単に入手できるようにするのに非常に役立ちます。
それを使用したくない場合は、代替手段を試すことができます: Bitbucket.
3. 自動ロードに慣れてください
PSR-4 互換のオートローダー名前空間を使用します。
コードを
srcフォルダーに入れてください。
4. Composer を通じて公開する
PHP の依存関係管理ツールである Composer を通してクラス ライブラリが見つかることを確認します
主要な Composer パッケージ リポジトリである Packagist で公開されます。
5. フレームワークに限定されない
1 つのフレームワークでのみ使用できるプロジェクトに限定されないでください。
サービスプロバイダーを通じてフレームワークに特別なサポートを提供します。
6. コーディング スタイルに従う
PSR-2 コーディング スタイルに従うことを強くお勧めします。
PHPコーディング標準フィクサーなどの自動コードフォーマットツールを使用します。
PHP コード スニファーなどのコード スタイル検出ツールを使用します。
7. 単体テストを作成します
コードの大部分をカバーします。
一般的に使用される PHP 単体テスト フレームワークである PHPUnit を使用します。
その他のオプション: phpspec、Behat、atoum、Codeception。
8. コードのコメントを書く
コメントを組み込みドキュメントとして扱います。
コード コメントは、PhpStorm などの IDE のコード自動補完機能を改善することもできます。
は API ドキュメントに自動的に変換できます。phpDocumentor を参照してください。
9. セマンティックバージョン管理を使用する
バージョン番号を管理するには、セマンティックバージョン番号を使用します。
メジャーバージョン.マイナーバージョン.パッチバージョンの仕様に従ってください。
開発者は、破壊的な変更を心配することなく、ソフトウェアを安全にアップグレードできます。
リリースバージョンに間に合うように忘れずにタグ付けしてください。
10. 定期的に更新ログを記録します
バージョン間の重要な変更を明確にマークして表示します。
CHANGELOG 形式に従うことを検討してください。
11. 継続的インテグレーションを使用する
サービスを使用して、コーディングが標準であるかどうか、および実行テストに合格できるかどうかを自動的にチェックします。
複数の異なる PHP バージョンでテストを実行することをお勧めします。
送信またはプル時に自動的に実行できることを確認してください。
参照: Travis-CI、Scrutinizer、Circle-CI。
12. 広範な使用法ドキュメントを作成する
拡張パッケージには優れたドキュメントが不可欠です。
少なくとも、ライブラリに詳細な README (readme) ファイルがあることを確認してください。
GitHub Pages でドキュメントをホストしてみることができます。
利用可能な参考文献: ドキュメントをお読みください。
13. ライセンスが含まれています
作業結果を効果的に保護することができ、簡単に実行できるライセンス契約が含まれています。
choosealicense.comを参照してください。 ほとんどの PHP オープンソース プロジェクトは MIT ライセンスを使用します。
少なくともコードベースに LICENSE ファイルを含めてください。
使用許諾契約を Docblocks に追加することも検討してください。
14. 皆さんの貢献を歓迎します
プロジェクトの改善に協力してもらいたい場合は、皆さんの貢献を求めなければなりません!
貢献者のリストをリストした CONTRIBUTING ファイルがあります。
このドキュメントは、テスト環境などのプロジェクト環境の要件を説明するために使用します。
より最新の PHP 知識については、Laravel / PHP Knowledge Community にアクセスしてください
関連する推奨事項:
以上がPHP 拡張機能開発チェックリストの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。