PHP 高度なプログラミング (1)_PHP チュートリアル

PHP高度プログラミング学習ノート20140612

ソフトウェア開発の重要な部分はドキュメントの作成です。これは、将来のプログラム管理者やユーザーが開発中の考え方を理解するのに役立ちます。また、将来、どこから始めればよいか分からない場合でもコードをレビューすることが容易になります。ドキュメントは、アクセスするオブジェクトの詳細を知らなくてもオブジェクト間の対話を可能にするという重要な役割も果たします。文書の作成には確立された業界標準フォーマットがいくつかあり、これらの業界標準に準拠することで、読みやすい表現を作成したり、マニュアルを自動生成したりすることが可能になります。

コーディング仕様

多くの開発者はコーディング標準について独自の見解や意見を持っている可能性があり、人それぞれ異なります。実際、チームメンバーが合意に達し、同じ基準に従っている限り、問題はありません。

PHP コミュニティは繁栄しており、多数の関数ライブラリ、フレームワーク、コンポーネントが存在します。通常、PHP 開発者は自分のプロジェクトで複数の外部ライブラリを使用するため、PHP コードが同じコード スタイルに従うか、可能な限りそれに近づけることが非常に重要です。これにより、開発者は複数のコード ライブラリを自分のプロジェクトに簡単に統合できます。 Framework Interop Group (つまり、PHP Standards Group) は、一連の推奨スタイルを公開しています。そのうちのいくつかは、PSR-0、PSR-1、PSR-2、PSR-4 というコーディング スタイルに関するものです。通常、他の開発者がコードを簡単に読んで使用できるように、PHP コードはこれらの標準の 1 つ以上に準拠する必要があります。これらの標準は以前の標準に新しいルールを追加するため、PSR-1 を使用するには PSR-0 への準拠が必要ですが、PSR-2 への準拠は必要ありません。

• PSR-0を読む
• PSR-1を読む
• PSR-2を読む
• PSR-4を読む
• PEAR コーディング標準について読む
• Zend コーディング標準について読む
• Symfony コーディング標準について読む

ドキュメントの作成 - コメントの種類

PHP で一般的に使用される 3 つのコメント方法 コメントはプログラムの可読性と保守性を高めるための方法であり、唯一の方法ではありません。可読性と保守性は主にコードの命名とプロジェクトの構成において向上します。

リーリー

最初のタイプのコメントは、人々に読んでもらうためのものであり、通常は短いコメントに使用されます。 2 番目のタイプ は、多くのコメントを必要とするコードで使用されます。 3 番目のタイプのコメントはドキュメント コメントと呼ばれ、解釈され、固定フォーマットでマニュアルに配置されます。コメントの種類には主に、クラス コメント、属性コメント、メソッド コメント、変数コメント、主要なアルゴリズム、重要なコード実装などが含まれます。これらすべての要素が織り込まれているため、後日人々はあなたが何をしたのか、そしてなぜそれをしたのかを正確に知ることができます。

ドキュメント作成 - 文法分析

プログラミング言語から実行可能コードへの変換プロセスは、文法解析と呼ばれます。文法パーサーは通常のコメントを検出すると、それを認識して無視し、コメント内のデータをクリーンアップするため、一般的なコメントはメタデータをインポートできません。

メタデータ

メタデータの定義は、データに関するデータです。これは広く普及している現象であり、多くの分野で特定の定義と応用が行われています。それは次のように定義されます: データを説明するデータ、データおよび情報リソースに関する説明情報。 PHP には、ほとんどのプログラミング要素のメタデータが含まれています。ただし、メタデータはドキュメントの自動生成に非常に役立つため、さらに多くのメタデータを埋め込むこともできます。この機能は、ドキュメントのコメントを解析することでシミュレートできます。特定の形式に従うドキュメント コメントを作成すると、パーサーはコメントを意味のあるドキュメントに自動的に変換できます。

PHPDoc

PHPDoc は、PHP ドキュメントを保守するためのソリューションです。これはドキュメント コメントの構造を定義し、パーサーが一貫した方法でコメントを解析できるようにします。 PHPDoc を使用すると、埋め込みドキュメントからマニュアルを作成できます。 すべてのドキュメント コメントと同様、PHPDoc 要件は /**アノテーション宣言が始まります。 PHPDoc の特別な点はタグです。 タグは、@ で始まり、その後に事前定義された識別子が続くことで表されます。 PHPDoc の詳細については、http://www.phpdoc.org/docs/latest/index.html を参照してください

PHPDoc仕様のコメント

コメントブロックは「/**」で始まり「」で終わる必要があります*/ で終わる必要があります。

最初のコメントと最後のコメントの間の各行はアスタリスク (*) で始まります。

タグは、 アットマーク (@) で始まり、その後に記号

が続く新しい行に記述する必要があります。

いくつかのタグは、関連付けられた要素に含まれる値の型を表す型をサポートまたは要求します。 この例は、メソッドまたは関数のパラメータの型を決定するための"paramタグです。 完全なリストはこちらです：

string：不特定の長さのテキスト。
int または integer：正または負のいずれかの整数。
float：正または負のいずれかである実数または 10 進数negative.
bool または boolean: 状態 'true' または 'false' のみを含むことができる変数。
array: 未知の型の変数のコレクション。配列メンバーのタイプを指定することができます。詳細については、配列に関する章を参照してください。
resource:PHP マニュアルに記載されているファイル ハンドラーまたはその他のシステム リソース。
null:含まれる値、または返される値、文字通りnullです。この型は、変数または値が完全に存在しないことを示す void と混同しないでください (通常は @return タグとともに使用されます)。
callable: 変数によって渡すことができる関数またはメソッド。PHP を参照してください。呼び出し可能なものについて詳しくは、マニュアルを参照してください。

下に列挙PHPDocの全部标签：

@api	@著者	@カテゴリー	@著作権	@非推奨	@例
@ファイルソース	@グローバル	@無視	@内部	@ライセンス	@リンク
@メソッド	@パッケージ	@param	@プロパティ	@property-read	@property-write
@戻る	@見る	@since	@ソース	@サブパッケージ	@throws
@todo	@用途	@var	@バージョン

http://www.bkjia.com/PHPjc/802363.htmlwww.bkjia.comtru​​ehttp://www.bkjia.com/PHPjc/802363.html技術記事 PHP 高級プログラム設計 20140612 パッケージの公開における 1 つの重要なプロトコルは、将来のプログラムの作成者と使用者の公開時の考え方を支援する可能性があります...