PHPのコメント構文仕様と命名規則を使用する手順の詳細な説明

今回は、PHPアノテーション文法仕様と命名規則を使用するための手順について詳しく説明します。PHPアノテーションを使用する際の注意点とは何ですか?実際の事例を見てみましょう。

HP コメント仕様

コメントは、コードを記述するプロセスにおいて非常に重要です。コードを記述する際には、コメントの仕様に注意する必要があります。

「PHP は、非常に使い始めるのが簡単な言語です。始めたばかりの初心者でも、echo を使用して数分以内に hello world を出力できるかもしれません。しかし、彼は本物のプログラマーでしょうか?プログラマーですか? 本当にプログラマーになりたければ、一連のプログラム作成基準に従わなければなりません。」しばらくすると彼らがやって来ます はい、どうしましょうか？もちろん、コードにコメントを追加するのが最善の方法です。

私たちはコメントや C pear PHP コメントなどを書く多くの方法に精通しているかもしれませんが、私たちが使用する主な方法は # と /**/。

#は短いコメントメソッドです。おそらく、これを使用して変数に注釈を付けたり、メソッドを呼び出したりすることになるでしょう。 /**/ であり、依然として大きなセクションをコメントアウトするために使用することがあります。関数の標準的なアノテーションはどうすればよいでしょうか?

/**

* @name name

* @abstract は変数/クラス/メソッドを宣言します
* @access はこの変数、クラス、関数/メソッドのアクセス権を指定します
* @author 関数作成者の名前とメールアドレス

* @ category はパッケージを整理します

* @copyright は著作権情報を指定します

* @const は定数を指定します
* @deprecate は非推奨または廃止された情報を指定します
* @example example
* @exclude は現在のコメントが分析されず、ドキュメントに表示されないことを指定します
* @final は、これが最終的なクラス、メソッド、属性であることを示し、派生と変更が禁止されています。
* @global はこの関数で参照されるグローバル変数を指定します
* @include はインクルードされるファイルの情報を指定します
* @link はオンライン接続を定義します
* @module は所属モジュール情報を定義します
* @modulegroup は所属モジュールグループを定義します
* @package は所属するパッケージの情報を定義します
* @param
関数
やメソッドのパラメータ情報を定義します* @return 関数やメソッドの戻り情報を定義します* @see は必要な関数や変数を定義しますを参照し、対応するスーパーリンクを追加します。
* @since は、API 関数またはメソッドがどのバージョンから導入されたかを示します。
* @static は、変数、クラス、関数が静的であることを示します。
* @throws は、この関数がスローする可能性のあるエラー例外と、それらが発生する状況を示します。
* @todo は、改善すべき領域または実装されない領域を示します。
* @var は、変数/属性を定義します。
* @version はバージョン情報を定義します
*/

注釈付きの情報は非常に包括的であり、私たちが使用していない情報もたくさんあるかもしれません。赤い部分は私たちがよく使用するものです。

例: PHP でのいくつかの一般的なコメント メソッド:

1. ファイル コメント、ファイル名、関数、作成者のバージョン番号およびその他の情報の紹介

/**
* 文件名简单介绍
* 
* 文件功能
* @author 作者
* @version 版本号
* @date 2020-02-02
*/

ファイル ヘッダー テンプレート

/** 
*这是一个什么文件 
* 
*此文件程序用来做什么的（详细说明，可选。）。 
* @author   richard<e421083458@163.com> 
* @version   $Id$ 
* @since    1.0 
*/

2. クラス コメント、クラス名と導入

/**
* 类的介绍
* 
* 类的详细介绍（可选）
* @author 作者
* @version 版本号
* @date 2020-02-02
*/

rree

3. 関数のコメント、関数の関数、パラメーターの導入と戻り値の型

/** 
* 类的介绍 
* 
* 类的详细介绍（可选。）。 
* @author     richard<e421083458@163.com> 
* @since     1.0 
*/ 
class Test  
{ 
}

関数ヘッダーのコメント

/**
* 函数的含义说明
* 
* @access public 
* @author 作者
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明
* @return array 返回类型
* @date 2020-02-02
*/

プログラムコードのコメント

1. コメントの原則は、多ければ多いほど良いということではなく、問題を明確に説明することです。

2. いくつかのステートメントが論理コード ブロックとして使用され、このブロックのコメントは /* */ にすることができます。

3. 特定のステートメントに固有のコメントには、行末コメント // を使用できます。

/** 
* some_func 
* 函数的含义说明 
* 
* @access public 
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明 
* @param mixed $mixed 这是一个混合类型 
* @since 1.0 
* @return array 
*/ 
public function thisIsFunction($string, $integer, $mixed) {return array();}

PHP 命名規則

1. ディレクトリとファイル

ディレクトリは小文字 + アンダースコアを使用します

クラス ライブラリ、関数ファイルには一律に .php の接尾辞が付けられます

クラスのファイル名はすべて
namespace
で定義されますnamespace パスはクラス ライブラリ ファイルが配置されているパスと一致します。クラス ファイルの名前はキャメル ケース (最初の文字は大文字) で付けられ、その他のファイルの名前は小文字 + 下線で付けられます。クラス名とクラス ファイル名は一致します。 、およびキャメルケース方式 (最初の文字が大文字) が一律に使用されます 2 .関数とクラス、属性の名前付け

クラスの名前は、User、UserType などのキャメルケース (最初の文字は大文字) で付けられます。たとえば、UserController には直接 User という名前を付ける必要があります。
関数名には小文字とアンダースコア (小文字で始まる) (get_client_ip など)
メソッドの名前は、getUserName などのキャメルケース (最初の文字は小文字) を使用して付けられます (メソッドに戻り値がある場合、現在、最初の文字が小文字の属性タイプを使用するのが通例です) s (文字列)、i (int)、f (float)、b (ブール値)、a (配列) など)
tableName などの属性の名前付けにはキャメルケース方式を使用します (最初の文字は小文字です)。 、インスタンス (現在、s (文字列)、i (int)、f(float)、b(boolean)、a(array) など、最初の文字が小文字の属性タイプを使用するのが通例です)
関数 または二重アンダースコア「」で始まるメソッドは、call や autoload などのマジック メソッドとして使用されます

3。定数と設定

定数は、APP_PATH や THINK_PATH などの大文字の名前文字とアンダースコアです
設定パラメータの名前は小文字とurl_route_on や url_convert などのアンダースコア

4. データ テーブル ボックスのフィールド

データ テーブルとフィールドの名前は小文字とアンダースコアで付けられます。think_user テーブルや user_name など、フィールド名がアンダースコアで始まらないように注意してください。フィールドでは、データ テーブルのフィールド名としてキャメル ケースと中国語を使用することはお勧めできません。

この記事の事例を読んだ後は、この方法を習得したと思います。さらに興味深い情報については、php 中国語 Web サイトの他の関連記事に注目してください。

推奨読書:

PHPを使用してWeChatリモートコントロールサーバーを開発する手順の詳細な説明

imagecopymerge()関数、半透明のウォーターマークを作成する手順の詳細な説明

以上がPHPのコメント構文仕様と命名規則を使用する手順の詳細な説明の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。