検索
ホームページバックエンド開発PHPチュートリアルPHPDocumentor アノテーション仕様 Organization_PHP チュートリアル

PHPDocumentorアノテーション仕様の整理

メモを書いてもらえますか?この問題は、コードを書き始めたときから私を悩ませてきましたが、他の学生も悩ませていると思います。以前は、コメントを書くための有効な標準がなく、最近まで phpdocumentor のコメント標準を読んでいました。そのため、メンテナンスや共同開発に多大な問題が生じていました。

以下はphpdocumentorのアノテーション標準の概要です:


タイプ(データ型):

    1. string 文字列型
    2. 整数または整数
    3. boolean または bool ブール型 true または false
    4. float または double 浮動小数点型
    5. オブジェクトオブジェクト
    6. 混合混合型は、型が指定されていない場合、または型が不明な場合に使用されます
    7. 配列配列
    8. resource リソースタイプ (データベースクエリによって返されるものなど)
    9. void null 値 (コントローラーの戻り値でよく使用されます)
    10. null null 型
    11. 呼び出し可能なコールバック関数
    12. true または fasle のみが返される場合は、false または true が使用されます
    13. 自分自身

      タグ:

      タグ

      要素

      説明

      アピ

      メソッド

      インターフェースを宣言する

      著者

      どれでも

      著者情報

      カテゴリー

      ファイル、クラス

      一連の要素をまとめて分類する

      著作権

      どれでも

      著作権情報

      非推奨

      どれでも

      宣言要素は非推奨であり、将来のバージョンでは削除される可能性があります

      どれでも

      ファイルソース

      ファイル

      ファイルリソース

      グローバル

      変数

      セット変数を宣言する

      無視

      どれでも

      現在の要素を無視します(phpdocumentorがドキュメントを生成するとき)

      内部

      どれでも

      値を整数として宣言するか、アプリケーションのデフォルト値を整数として設定します

      ライセンス

      ファイル、クラス

      ライセンスの種類を宣言する

      リンク

      どれでも

      現在の要素に関連するリンクを宣言します

      方法

      クラス

      現在のクラスのどのマジックメソッドを呼び出すことができるかを宣言します

      パッケージ

      ファイル、クラス

      現在の要素が属するパッケージを宣言します

      パラメータ

      メソッド、関数

      現在の要素のパラメータを宣言する

      プロパティ

      クラス

      呼び出し可能なマジックメソッドを持つ現在のクラスのプロパティを宣言します

      プロパティ読み取り

      クラス

      現在のクラスがプロパティを読み取る必要があるマジックメソッドを宣言します

      プロパティ書き込み

      クラス

      現在のクラスがプロパティを設定する必要があるマジックメソッドを宣言します

      戻る

      メソッド、関数

      戻り値

      参照

      どれでも

      現在の要素パラメータが他のサイトまたは要素を参照していることを説明します

      以来

      どれでも

      現在の要素がどのバージョンから始まるかを宣言します

      ソース

      ファイルを除くすべて

      現在の要素のソースコードを表示します

      サブパッケージ

      ファイル、クラス

      カテゴリの現在の要素

      投げる

      メソッド、関数

      現在の要素によってスローされる例外を説明します

      やること

      どれでも

      要素の現在の開発アクティビティについて説明します

      用途

      どれでも

      関連要素を参照する

      変数

      プロパティ

      属性を宣言する

      バージョン

      どれでも

      バージョン

      例:

      // =============================

      @api

      リーリー

      // =============================

      @著者

      リーリー

      // =============================

      @カテゴリー

      リーリー

      // =============================

      @著作権

      リーリー

      // =============================

      @非推奨

      リーリー

      // =============================

      @例

      リーリー

      // =============================

      @ファイルソース

      リーリー

      // =============================

      @global phpdocumentor2.0 はサポートされていません

      // =============================

      @無視

      リーリー

      // =============================

      @内部

      リーリー

      リーリー

      // =============================

      @ライセンス

      リーリー

      // =============================

      @リンク

      リーリー

      リーリー

      // =============================

      @メソッド

      リーリー

      // =============================

      @パッケージ

      リーリー

      // =============================

      @param

      リーリー

      // =============================

      @プロパティ

      リーリー

      // =============================

      @property-read

      リーリー

      // =============================

      @property-write

      リーリー

      // =============================

      @戻る

      リーリー

      リーリー

      // =============================

      @見る

      リーリー

      // =============================

      @since

      リーリー

      リーリー

      // =============================

      @ソース

      リーリー

      // =============================

      @サブパッケージ

      リーリー

      // =============================

      @throws

      リーリー

      // =============================

      @todo

      リーリー

      // =============================

      @uses

       

       

      /**
        * @uses MyClass::$items to retrieve the count from.
        *
        * @return integer Indicates the number of items.
        */
       function count()
       {
           <...>
       }

       

       

      // =============================

       

      @var

       

       

       class Counter
       {
      /**
        * @var
        */
      public $var;
       }

       

       

      // =============================

       

      @version

       

       

      /**
        * @version 1.0.1
        */
       class Counter
       {
           <...>
       }

       

       

       

       /**
        * @version GIT: $Id$ In development. Very unstable.
        */
       class NeoCounter
       {
           <...>
       }

       

       

       

       

       

       

www.bkjia.comtruehttp://www.bkjia.com/PHPjc/857042.htmlTechArticlePHPDocumentor 注释规范整理 你会写注释么?从我写代码开始,这个问题就一直困扰着我,相信也同样困扰着其他同学。以前的写注释总是没有...
声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
誇大広告を超えて:今日のPHPの役割の評価誇大広告を超えて:今日のPHPの役割の評価Apr 12, 2025 am 12:17 AM

PHPは、特にWeb開発の分野で、最新のプログラミングで強力で広く使用されているツールのままです。 1)PHPは使いやすく、データベースとシームレスに統合されており、多くの開発者にとって最初の選択肢です。 2)動的コンテンツ生成とオブジェクト指向プログラミングをサポートし、Webサイトを迅速に作成および保守するのに適しています。 3)PHPのパフォーマンスは、データベースクエリをキャッシュおよび最適化することで改善でき、その広範なコミュニティと豊富なエコシステムにより、今日のテクノロジースタックでは依然として重要になります。

PHPの弱い参照は何ですか、そしていつ有用ですか?PHPの弱い参照は何ですか、そしていつ有用ですか?Apr 12, 2025 am 12:13 AM

PHPでは、弱い参照クラスを通じて弱い参照が実装され、ガベージコレクターがオブジェクトの回収を妨げません。弱い参照は、キャッシュシステムやイベントリスナーなどのシナリオに適しています。オブジェクトの生存を保証することはできず、ごみ収集が遅れる可能性があることに注意する必要があります。

PHPで__invoke Magicメソッドを説明してください。PHPで__invoke Magicメソッドを説明してください。Apr 12, 2025 am 12:07 AM

\ _ \ _ Invokeメソッドを使用すると、オブジェクトを関数のように呼び出すことができます。 1。オブジェクトを呼び出すことができるように\ _ \ _呼び出しメソッドを定義します。 2。$ obj(...)構文を使用すると、PHPは\ _ \ _ Invokeメソッドを実行します。 3。ロギングや計算機、コードの柔軟性の向上、読みやすさなどのシナリオに適しています。

同時性については、PHP 8.1の繊維を説明します。同時性については、PHP 8.1の繊維を説明します。Apr 12, 2025 am 12:05 AM

繊維はPhp8.1で導入され、同時処理機能が改善されました。 1)繊維は、コルーチンと同様の軽量の並行性モデルです。 2)開発者がタスクの実行フローを手動で制御できるようにし、I/O集約型タスクの処理に適しています。 3)繊維を使用すると、より効率的で応答性の高いコードを書き込むことができます。

PHPコミュニティ:リソース、サポート、開発PHPコミュニティ:リソース、サポート、開発Apr 12, 2025 am 12:04 AM

PHPコミュニティは、開発者の成長を支援するための豊富なリソースとサポートを提供します。 1)リソースには、公式のドキュメント、チュートリアル、ブログ、LaravelやSymfonyなどのオープンソースプロジェクトが含まれます。 2)StackOverFlow、Reddit、およびSlackチャネルを通じてサポートを取得できます。 3)開発動向は、RFCに従うことで学ぶことができます。 4)コミュニティへの統合は、積極的な参加、コード共有への貢献、および学習共有への貢献を通じて達成できます。

PHP対Python:違いを理解しますPHP対Python:違いを理解しますApr 11, 2025 am 12:15 AM

PHP and Python each have their own advantages, and the choice should be based on project requirements. 1.PHPは、シンプルな構文と高い実行効率を備えたWeb開発に適しています。 2。Pythonは、簡潔な構文とリッチライブラリを備えたデータサイエンスと機械学習に適しています。

PHP:それは死にかけていますか、それとも単に適応していますか?PHP:それは死にかけていますか、それとも単に適応していますか?Apr 11, 2025 am 12:13 AM

PHPは死にかけていませんが、常に適応して進化しています。 1)PHPは、1994年以来、新しいテクノロジーの傾向に適応するために複数のバージョンの反復を受けています。 2)現在、電子商取引、コンテンツ管理システム、その他の分野で広く使用されています。 3)PHP8は、パフォーマンスと近代化を改善するために、JITコンパイラおよびその他の機能を導入します。 4)Opcacheを使用してPSR-12標準に従って、パフォーマンスとコードの品質を最適化します。

PHPの未来:適応と革新PHPの未来:適応と革新Apr 11, 2025 am 12:01 AM

PHPの将来は、新しいテクノロジーの傾向に適応し、革新的な機能を導入することで達成されます。1)クラウドコンピューティング、コンテナ化、マイクロサービスアーキテクチャに適応し、DockerとKubernetesをサポートします。 2)パフォーマンスとデータ処理の効率を改善するために、JITコンパイラと列挙タイプを導入します。 3)パフォーマンスを継続的に最適化し、ベストプラクティスを促進します。

See all articles

ホットAIツール

Undresser.AI Undress

Undresser.AI Undress

リアルなヌード写真を作成する AI 搭載アプリ

AI Clothes Remover

AI Clothes Remover

写真から衣服を削除するオンライン AI ツール。

Undress AI Tool

Undress AI Tool

脱衣画像を無料で

Clothoff.io

Clothoff.io

AI衣類リムーバー

AI Hentai Generator

AI Hentai Generator

AIヘンタイを無料で生成します。

ホットツール

SecLists

SecLists

SecLists は、セキュリティ テスターの究極の相棒です。これは、セキュリティ評価中に頻繁に使用されるさまざまな種類のリストを 1 か所にまとめたものです。 SecLists は、セキュリティ テスターが必要とする可能性のあるすべてのリストを便利に提供することで、セキュリティ テストをより効率的かつ生産的にするのに役立ちます。リストの種類には、ユーザー名、パスワード、URL、ファジング ペイロード、機密データ パターン、Web シェルなどが含まれます。テスターはこのリポジトリを新しいテスト マシンにプルするだけで、必要なあらゆる種類のリストにアクセスできるようになります。

SublimeText3 Mac版

SublimeText3 Mac版

神レベルのコード編集ソフト(SublimeText3)

EditPlus 中国語クラック版

EditPlus 中国語クラック版

サイズが小さく、構文の強調表示、コード プロンプト機能はサポートされていません

メモ帳++7.3.1

メモ帳++7.3.1

使いやすく無料のコードエディター

VSCode Windows 64 ビットのダウンロード

VSCode Windows 64 ビットのダウンロード

Microsoft によって発売された無料で強力な IDE エディター