Ground Sunlight

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

ユーザ用ツール

サイト用ツール

トレース:
psr:psr19

差分

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

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

両方とも前のリビジョン 前のリビジョン
次のリビジョン 		前のリビジョン
psr:psr19 [2020/09/17 11:18]
y2sunlight [5.14. @throws] 		psr:psr19 [2020/09/17 11:43] (現在)
y2sunlight
行 1: 行 1:
-> 編集中 
- 
 ====== PSR-19: PHPDoc tags(Draft) ====== ====== PSR-19: PHPDoc tags(Draft) ======
  
行 700: 行 698:
 この情報を使用して、特定の要素に対して必要なアプリケーションバージョンをコンシューマに通知する一連のAPIドキュメントを生成できます。 この情報を使用して、特定の要素に対して必要なアプリケーションバージョンをコンシューマに通知する一連のAPIドキュメントを生成できます。
  
-要素の現在のバージョンを表示するために @since タグを使用すべきではありません( ''SHOULD NOT'' )。その目的では、@version タグが使用できます( ''MAY'' )。+要素の現在のバージョンを表示するために @since タグを使用すべきではありません( ''SHOULD NOT'' )。@version タグを、その目的で使用できます( ''MAY'' )。
  
 === 例 ==== === 例 ====
行 773: 行 771:
 ==== 5.15. @todo ===== ==== 5.15. @todo =====
  
-The @todo tag is used to indicate whether any development activities should still be executed on associated "Structural Elements". +@todo タグは、関連する「構造的要素」で開発アクティビティを実行する必要があるかどうかを示すために使用されます。
- +
-@todoタグは、関連する「構造的要素」で開発アクティビティを実行する必要があるかどうかを示すために使用されます。+
  
 === 構文 ==== === 構文 ====
行 785: 行 781:
 === 説明 ==== === 説明 ====
  
-The @todo tag is used to indicate that an activity surrounding the associated "Structural Elements" must still occur. Each tag MUST be accompanied by a description that communicates the intent of the original author; this could however be as short as providing an issue number. +@todo タグは、関連する「構造的要素」を取り巻くアクティビティが引き続き発生する必要があることを示すために使用されます。各タグには、原作者の意図を伝える説明を添付する必要があります( ''MUST'' )。ただし、これは問題番号を提供するのと同じくらい短い場合があります。
- +
-@todoタグは、関連する「構造的要素」を取り巻くアクティビティが引き続き発生する必要があることを示すために使用されます。各タグには、原作者の意図を伝える説明を添付する必要があります( MUST )。ただし、これは問題番号を提供するのと同じくらい短い場合があります。+
  
 === 例 ==== === 例 ====
行 808: 行 802:
  
 ==== 5.16. @uses ===== ==== 5.16. @uses =====
- 
-Indicates whether the current "Structural Element" consumes the "Structural Element", or project file, that is provided as target. 
  
 現在の「構造的要素」がターゲットとして提供されている「構造的要素」またはプロジェクトファイルを使用するかどうかを示します。 現在の「構造的要素」がターゲットとして提供されている「構造的要素」またはプロジェクトファイルを使用するかどうかを示します。
行 820: 行 812:
  
 === 説明 ==== === 説明 ====
- 
-The @uses tag describes whether any part of the associated "Structural Element" uses, or consumes, another "Structural Element" or a file that is situated in the current project. 
  
 ''@uses'' タグは、関連する「構造的要素」の一部が別の「構造的要素」または現在のプロジェクトにあるファイルを使用するかどうかを示します。 ''@uses'' タグは、関連する「構造的要素」の一部が別の「構造的要素」または現在のプロジェクトにあるファイルを使用するかどうかを示します。
- 
-When defining a reference to another "Structural Element" you can refer to a specific element by appending a double colon and providing the name of that element (also called the "FQSEN"). 
  
 別の「構造的要素」への参照を定義する場合、二重のコロンを追加し、その要素の名前（「FQSEN」とも呼ばれる）を指定することにより、特定の要素を参照できます。 別の「構造的要素」への参照を定義する場合、二重のコロンを追加し、その要素の名前（「FQSEN」とも呼ばれる）を指定することにより、特定の要素を参照できます。
- 
-Files that are contained in this project can be referred to by this tag. This can be used, for example, to indicate a relationship between a Controller and a template file (as View). 
  
 このプロジェクトに含まれるファイルは、このタグで参照できます。これは、例えば、コントローラーと（ビューとしての）テンプレートファイルの間の関係を示すために使用できます。 このプロジェクトに含まれるファイルは、このタグで参照できます。これは、例えば、コントローラーと（ビューとしての）テンプレートファイルの間の関係を示すために使用できます。
  
-This tag MUST NOT be used to indicate relations to elements outside of the system, so URLs are not usable. To indicate relations with outside elements the @see tag can be used. +このタグは、システム外の要素との関係を示すために使用してはならないため( ''MUST NOT'' )、URLは使用できません。外部要素との関係を示すには、@see タグを使用できます。
- +
-このタグは、システム外の要素との関係を示すために使用してはならないため( ''MUST NOT'' )、URLは使用できません。外部要素との関係を示すには、@seeタグを使用できます。 +
- +
-Applications consuming this tag, such as generators, are RECOMMENDED to provide a @used-by tag on the destination element. This can be used to provide a bi-directional experience and allow for static analysis.+
  
 ジェネレータなど、このタグを使用するアプリケーションは、宛先要素に ''@used-by'' タグを提供することをお勧めします( ''RECOMMENDED'' )。これは、双方向のエクスペリエンスを提供し、静的分析を可能にするために使用できます。 ジェネレータなど、このタグを使用するアプリケーションは、宛先要素に ''@used-by'' タグを提供することをお勧めします( ''RECOMMENDED'' )。これは、双方向のエクスペリエンスを提供し、静的分析を可能にするために使用できます。
行 867: 行 849:
 ==== 5.17. @var ===== ==== 5.17. @var =====
  
-You may use the @var tag to document the "Type" of the following "Structural Elements":+@var タグを使用して、次の「構造的要素」の「タイプ」を文書化できます。
  
-@varタグを使用して、次の「構造的要素」の「タイプ」を文書化できます。 +  * クラススコープ と グローバルスコープ の両方の定数
- +
- +
-  * Constants, both class and global scope +
-  * Properties +
-  * Variables, both global and local scope +
- +
-  * クラススコープとグローバルスコープの両方の定数+
   * プロパティ   * プロパティ
-  * 変数、グローバルスコープとローカルスコープの両方+  * 変数、グローバルスコープ と ローカルスコープ の両方
  
 === 構文 ==== === 構文 ====
行 888: 行 863:
 === 説明 ==== === 説明 ====
  
-The @var tag defines which type of data is represented by a value of a Constant, Property or Variable.+@var タグは、定数、プロパティ、または変数の値によって表されるデータのタイプを定義します。
  
-@varタグは、定数、プロパティ、または変数の値によって表されるデータのタイプを定義します。+型が曖昧または不明である各定数またはプロパティ定義、または変数の前には、@var タグを含むDocBlockを付けるべきです( ''SHOULD'' )。他の変数の前にも、@varタグを含むDocBlockを付けることができます( ''MAY'' )。
  
-Each Constant or Property definition or Variable where the type is ambiguous or unknown SHOULD be preceded by a DocBlock containing the @var tag. Any other variable MAY be preceded with a DocBlock containing the @var tag.+@var タグには、ドキュメント化する要素の名前を含める必要があります( ''MUST'' )。これの例外は、プロパティ宣言が単一のプロパティのみを参照する場合です。この場合、プロパティの名前は省略できます( ''MAY'' )。
  
-型があいまいまたは不明である各定数またはプロパティ定義または変数の前には、@varタグを含むDocBlockを付けるべきです( ''SHOULD'' )。他の変数の前にも、@varタグを含むDocBlockを付けることができます( ''MAY'' )。 +これは、複合ステートメントを使用して一連の定数またはプロパティを定義するときに使用されます。このような複合ステートメントは、複数のアイテムが表されている間、DocBlock を1つだけ持つことができます。
- +
-The @var tag MUST contain the name of the element it documents. An exception to this is when property declarations only refer to a single property. In this case the name of the property MAY be omitted. +
- +
-@varタグには、ドキュメント化する要素の名前を含める必要があります( ''MUST'' )。これの例外は、プロパティ宣言が単一のプロパティのみを参照する場合です。この場合、プロパティの名前は省略できます( ''MAY'' )。 +
- +
-This is used when compound statements are used to define a series of Constants or Properties. Such a compound statement can only have one DocBlock while several items are represented. +
- +
-これは、複合ステートメントを使用して一連の定数またはプロパティを定義するときに使用されます。このような複合ステートメントは、複数のアイテムが表されている間、DocBlockを1つだけ持つことができます。+
  
 === 例 ==== === 例 ====
  
 <code php> <code php>
-/** @var int $intこれはカウンターです。 */+/** @var int $int これはカウンターです。 */
 $int = 0; $int = 0;
  
-// there should be no docblock here +// ここには docblock があるべきではありません
-// ここにはdocblockがあるべきではありません+
 $int++; $int++;
 </code> </code>
行 927: 行 893:
   public function setDescription($description)   public function setDescription($description)
   {   {
-      // there should be no docblock here +      // ここには docblock があるべきではありません
-      // ここにはdocblockがあるべきではありません+
       $this->description = $description;       $this->description = $description;
   }   }
行 934: 行 899:
 </code> </code>
  
-Another example is to document the variable in a foreach explicitly; many IDEs use this information to help you with auto-completion: +他の例としては、foreach 中の変数を明示的に文書化することです。多くの IDE はこの情報を使用して、オートコンプリートを支援します：
- +
-他の例としては、foreach中の変数を明示的に文書化することです。多くのIDEはこの情報を使用して、オートコンプリートを支援します：+
  
 <code php> <code php>
 /** @var \Sqlite3 $sqlite */ /** @var \Sqlite3 $sqlite */
 foreach ($connections as $sqlite) { foreach ($connections as $sqlite) {
-    // there should be no docblock here +    // ここには docblock があるべきではありません
-    // ここにはdocblockがあるべきではありません+
     $sqlite->open('/my/database/path');     $sqlite->open('/my/database/path');
     <...>     <...>
 } }
 </code> </code>
- 
-Even compound statements may be documented: 
  
 複合ステートメントでも文書化できます： 複合ステートメントでも文書化できます：
行 992: 行 952:
 ==== 5.18. @version ===== ==== 5.18. @version =====
  
-The @version tag is used to denote some description of "versioning" to an element. +@version タグは、要素に対する「バージョニング」の説明を示すために使用されます。
- +
-@versionタグは、要素に対する「バージョニング」の説明を示すために使用されます。+
  
 === 構文 ==== === 構文 ====
行 1003: 行 961:
  
 === 説明 ==== === 説明 ====
- 
-Documents the current "version" of any element. 
  
 要素の現在の「バージョン」を文書化します。 要素の現在の「バージョン」を文書化します。
- 
-This information can be used to generate a set of API Documentation where the consumer is informed about elements at a particular version. 
  
 この情報を使用して、特定のバージョンの要素についてコンシューマに通知するAPIドキュメントのセットを生成できます。 この情報を使用して、特定のバージョンの要素についてコンシューマに通知するAPIドキュメントのセットを生成できます。
  
-It is RECOMMENDED that the version number matches a semantic version number as described in the Semantic Versioning Standard version 2.0.+[[https://semver.org/|Semantic Versioning Standard version 2.0]] で説明されているように、バージョン番号がセマンティックバージョン番号と一致することが推奨されます( ''RECOMMENDED'' )。
  
-[[https://semver.org/|Semantic Versioning Standard version 2.0]]で説明されているように、バージョン番号がセマンティックバージョン番号と一致することが推奨されます( ''RECOMMENDED'' )。+バージョン管理システムのバージョンベクトルもサポートされていますが、次の形式に従う必要があります( ''MUST'' )。
  
-Version vectors from Version Control Systems are also supported, though they MUST follow the form: +<code>
- +
-バージョン管理システムのバージョンベクターもサポートされていますが、次の形式に従う必要があります( ''MUST'' )。 +
- +
-<code php>+
 name-of-vcs: $vector$ name-of-vcs: $vector$
 </code> </code>
- 
-A description MAY be provided, for the purpose of communicating any additional version-specific information. 
  
 バージョン固有の追加情報を伝える目的で、説明が提供される場合があります( ''MAY'' )。 バージョン固有の追加情報を伝える目的で、説明が提供される場合があります( ''MAY'' )。
  
-The @version tag MAY NOT be used to show the last modified or introduction version of an element, the @since tag SHOULD be used for that purpose. +@version タグは、要素の最終変更バージョンまたは導入バージョンを示すために使用することはできません( ''MAY NOT'' )。@sinceタグを、その目的で使用すべきです( ''SHOULD'' )。
- +
-@versionタグは、要素の最終変更バージョンまたは導入バージョンを示すために使用することはできません( ''MAY NOT'' )。@sinceタグを、その目的で使用すべきです( ''SHOULD'' )。+
  
 === 例 ==== === 例 ====
psr/psr19.1600309134.txt.gz · 最終更新: 2020/09/17 11:18 by y2sunlight

ページ用ツール

特に明示されていない限り、本Wikiの内容は次のライセンスに従います： CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki