検索
ホームページバックエンド開発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 27, 2025 am 12:23 AM

tomodifydatainaphpsession、starthessession withsession_start()、$ _sessiontoset、modify、orremovevariables.1)startthessession.2)

PHPセッションに配列を保存する例を示します。PHPセッションに配列を保存する例を示します。Apr 27, 2025 am 12:20 AM

配列はPHPセッションに保存できます。 1。セッションを開始し、session_start()を使用します。 2。配列を作成し、$ _Sessionで保存します。 3. $ _Sessionを介して配列を取得します。 4.セッションデータを最適化してパフォーマンスを向上させます。

Garbage CollectionはPHPセッションでどのように機能しますか?Garbage CollectionはPHPセッションでどのように機能しますか?Apr 27, 2025 am 12:19 AM

PHPセッションガベージコレクションは、有効期限が切れたセッションデータをクリーンアップするために確率メカニズムを通じてトリガーされます。 1)構成ファイルにトリガー確率とセッションのライフサイクルを設定します。 2)Cronタスクを使用して、高負荷アプリケーションを最適化できます。 3)データの損失を避けるために、ごみ収集の頻度とパフォーマンスのバランスを取る必要があります。

どのようにしてPHPでセッションアクティビティをトレースできますか?どのようにしてPHPでセッションアクティビティをトレースできますか?Apr 27, 2025 am 12:10 AM

PHPでのユーザーセッションアクティビティの追跡は、セッション管理を通じて実装されます。 1)SESSION_START()を使用してセッションを開始します。 2)$ _Sessionアレイを介してデータを保存およびアクセスします。 3)セッションを終了するには、session_destroy()を呼び出します。セッショントラッキングは、ユーザーの動作分析、セキュリティ監視、パフォーマンスの最適化に使用されます。

データベースを使用してPHPセッションデータを保存するにはどうすればよいですか?データベースを使用してPHPセッションデータを保存するにはどうすればよいですか?Apr 27, 2025 am 12:02 AM

データベースを使用してPHPセッションデータを保存すると、パフォーマンスとスケーラビリティが向上します。 1)MySQLを構成してセッションデータを保存します:PHP.iniまたはPHPコードでセッションプロセッサを設定します。 2)カスタムセッションプロセッサを実装します:データベースと対話するために、開いて、閉じ、読み取り、書き込み、その他の機能を定義します。 3)最適化とベストプラクティス:インデックス、キャッシュ、データ圧縮、分散ストレージを使用して、パフォーマンスを向上させます。

PHPセッションの概念を簡単に説明してください。PHPセッションの概念を簡単に説明してください。Apr 26, 2025 am 12:09 AM

phpssionsStrackuserdataacrossmultiplepagerequestsusingauniqueidstoredinacookie.here'showtomanageetheemefectively:1)Startassession withsession_start()andstoredatain $ _ session.2)RegeneratesseSsessidafterloginwithsession_id(the topreventes_id)

PHPセッションに保存されているすべての値をどのようにループしますか?PHPセッションに保存されているすべての値をどのようにループしますか?Apr 26, 2025 am 12:06 AM

PHPでは、次の手順を通じてセッションデータを繰り返すことができます。1。session_start()を使用してセッションを開始します。 2。$ _Sessionアレイのすべてのキー価値ペアを介してforeachループを反復します。 3.複雑なデータ構造を処理する場合、is_array()またはis_object()関数を使用し、print_r()を使用して詳細情報を出力します。 4.トラバーサルを最適化する場合、ページングを使用して、一度に大量のデータの処理を避けることができます。これにより、実際のプロジェクトでPHPセッションデータをより効率的に管理および使用するのに役立ちます。

ユーザー認証にセッションを使用する方法を説明します。ユーザー認証にセッションを使用する方法を説明します。Apr 26, 2025 am 12:04 AM

このセッションは、サーバー側の状態管理メカニズムを介してユーザー認証を実現します。 1)セッションの作成と一意のIDの生成、2)IDはCookieを介して渡されます。3)サーバーストアとIDを介してセッションデータにアクセスします。

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衣類リムーバー

Video Face Swap

Video Face Swap

完全無料の AI 顔交換ツールを使用して、あらゆるビデオの顔を簡単に交換できます。

ホットツール

AtomエディタMac版ダウンロード

AtomエディタMac版ダウンロード

最も人気のあるオープンソースエディター

SAP NetWeaver Server Adapter for Eclipse

SAP NetWeaver Server Adapter for Eclipse

Eclipse を SAP NetWeaver アプリケーション サーバーと統合します。

Dreamweaver Mac版

Dreamweaver Mac版

ビジュアル Web 開発ツール

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

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

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

WebStorm Mac版

WebStorm Mac版

便利なJavaScript開発ツール