Ground Sunlight

Windowsで作る - PHPプログラミングの開発環境

ユーザ用ツール

サイト用ツール


psr:psr5

差分

このページの2つのバージョン間の差分を表示します。

この比較画面にリンクする

両方とも前のリビジョン 前のリビジョン
次のリビジョン
前のリビジョン
psr:psr5 [2020/05/18 17:35]
y2sunlight [キーワード]
psr:psr5 [2020/09/01 11:52] (現在)
tanaka [PSR-5: PHPDoc Standard(Draft)]
行 1: 行 1:
->編集中 
- 
------ 
- 
 ====== PSR-5: PHPDoc Standard(Draft) ====== ====== PSR-5: PHPDoc Standard(Draft) ======
  
  --- //[[http://www.y2sunlight.com|y2sunlight]] 2020-04-28//  --- //[[http://www.y2sunlight.com|y2sunlight]] 2020-04-28//
  
-本章は、若干の補足を加筆してはいるものの単に[[https://www.php-fig.org/psr/|PSRのサイト]]を翻訳したものに過ぎません。英語が堪能な方は原文をご参照下さい。翻訳に当たっては、基本的に機械翻訳を使い、理解できない部分は独断で意訳しております。拙い訳では御座いますが恥を忍んで投稿しておりますので、ご指摘など御座いましたらコメントを頂ければ幸いです。+本章は、若干の補足を加筆してはいるものの単に[[https://www.php-fig.org/psr/|PSRのサイト]]を日本語に翻訳したものに過ぎません。英語が堪能な方は原文をご参照下さい。翻訳に当たっては、基本的に機械翻訳を使い、理解できない部分は独断で意訳しております。拙い訳では御座いますが恥を忍んで投稿しておりますので、ご指摘など御座いましたらコメントを頂ければ幸いです。 
 + 
 +関連記事
  
-==== 目次 ==== +  * [[psr:top|PSR - PHP標準勧告]]
-  * [[psr:top|PHP - PHP標準勧告]]+
   * [[psr:psr1|PSR-1: Basic Coding Standard - 基本コーディング規約]]   * [[psr:psr1|PSR-1: Basic Coding Standard - 基本コーディング規約]]
   * [[psr:psr3|PSR-3: Logger Interface - ロガーインターフェイス]]   * [[psr:psr3|PSR-3: Logger Interface - ロガーインターフェイス]]
行 16: 行 13:
   * PSR-5: PHPDoc Standard(Draft) - PHPDoc規約   * PSR-5: PHPDoc Standard(Draft) - PHPDoc規約
   * [[psr:psr6|PSR-6: Caching Interface - キャッシングインターフェイス]]    * [[psr:psr6|PSR-6: Caching Interface - キャッシングインターフェイス]] 
 +  * [[psr:psr7|PSR-7: HTTP Message Interface - HTTPメッセージインターフェイス]] 
 +  * [[psr:psr11|PSR-11: Container Interface - コンテナインターフェイス]] 
 +  * [[psr:psr12|PSR-12: Extended Coding Style - 拡張コーディングスタイル]] 
 +  * [[psr:psr13|PSR-13: Link definition interfaces - リンク定義インターフェース]]
 +  * [[psr:psr14|PSR-14: Event Dispatcher - イベントディスパッチャー]] 
 +  * [[psr:psr15|PSR-15: HTTP Server Request Handlers - HTTPサーバーリクエストハンドラー]] 
 +  * [[psr:psr16|PSR-16: Common Interface for Caching Libraries - キャッシングライブラリのための共通インターフェース]] 
 +  * [[psr:psr17|PSR-17: HTTP Factories - HTTPファクトリー]] 
 +  * [[psr:psr18|PSR-18: HTTP Client - HTTPクライアント]] 
 +  * [[psr:psr19|PSR-19: PHPDoc tags(Draft) - PHPDocタグ]] 
  
 \\ \\
行 411: 行 418:
 ===== 付録A. タイプ ====== ===== 付録A. タイプ ======
  
-===== ABNF =====+==== ABNF ====
  
 タイプには次の[[https://tools.ietf.org/html/rfc5234|ABNF]]定義があります。 タイプには次の[[https://tools.ietf.org/html/rfc5234|ABNF]]定義があります。
行 427: 行 434:
 \\ \\
  
-===== 詳細 =====+==== 詳細 ====
  
 ''タイプ'' が使用される場合、ユーザーは以下に詳述するように、値または値のセットを期待します。 ''タイプ'' が使用される場合、ユーザーは以下に詳述するように、値または値のセットを期待します。
行 446: 行 453:
 \\ \\
  
-===== 配列 =====+==== 配列 ====
  
 ''タイプ'' で表される値は配列にすることができます。このタイプは、次のオプションのいずれかの形式に従って定義する必要があります (''MUST'')。 ''タイプ'' で表される値は配列にすることができます。このタイプは、次のオプションのいずれかの形式に従って定義する必要があります (''MUST'')。
行 456: 行 463:
 \\ \\
  
-===== 有効なクラス名 =====+==== 有効なクラス名 ====
  
 有効なクラス名は、タイプが言及しているコンテキストに基づいて参照されます。従って、これは完全修飾クラス名(FQCN)であるか。または名前空間内に存在ローカル名であるかのいずれかになります。 有効なクラス名は、タイプが言及しているコンテキストに基づいて参照されます。従って、これは完全修飾クラス名(FQCN)であるか。または名前空間内に存在ローカル名であるかのいずれかになります。
行 470: 行 477:
 \\ \\
  
-===== キーワード =====+==== キーワード ====
  
 キーワードは、タイプの目的を定義します。すべての要素がクラスによって決められているわけではなく、開発者が ''DocBlock'' の対象となるコードの理解に役立つ分類には価値があります。 キーワードは、タイプの目的を定義します。すべての要素がクラスによって決められているわけではなく、開発者が ''DocBlock'' の対象となるコードの理解に役立つ分類には価値があります。
行 544: 行 551:
 === 例(前の例の状況が引き続き適用されます): === === 例(前の例の状況が引き続き適用されます): ===
  
-TODO:+クラス B はクラス A を拡張し、メソッドcを再定義しません。そのため、クラス B からメソッド c を呼び出すことができます。 
 + 
 +この状況では、**self** がクラス A または B のいづれかとして解釈されるため、あいまいさが生じる可能性があります。これらの場合、**self** は、**self** タイプを含む **DocBlock** が記述されているクラスのインスタンスであると解釈しなければなりません (''MUST'')。
  
-TODO:+上記の例で、**self** はクラス A のメソッド c で定義されているため、常にクラスAを参照する必要があります(''self'')。
  
 +> 上記の性質により、この情報を収集し形成化するアプリケーションでは、クラスの各表現とともに子クラスのリストを表示することをお勧めします (''RECOMMENDED'')。 これにより、どのクラスが型として受け入れられるかがユーザーに明らかになります。
 </div> </div>
-  - **static**: +  - **static**:この型が適用される要素は、ドキュメント化された要素が含まれているのと同じクラスであるか、またはサブクラスで見つかった場合、元のクラスではなくそのサブクラスの型です。\\ \\ このキーワードは、PHPで定義されている(静的メソッドやプロパティ、または変数修飾子でもない)[[https://www.php.net/manual/ja/language.oop5.late-static-bindings.php|遅延静的束縛(Late Static Bindings)]]に対するキーワードと同じように動作します。\\ \\  
-  - **$this**:+  - **$this**:このタイプが適用される要素は、与えられたコンテキストの現在のクラスとまったく同じインスタンスです。そのため、返されるインスタンスは同じクラスだけでなく同じインスタンスでなければならないので、このタイプは static のより厳密なバージョンという事になります。\\ \\ このタイプは、[[https://en.wikipedia.org/wiki/Fluent_interface|Fluent Interface]]デザインパターン(流れるようなインターフェース) を実装するメソッドの戻り値としてよく使用されます。
  
 \\ \\
  
  
psr/psr5.1589790938.txt.gz · 最終更新: 2020/05/18 17:35 by y2sunlight