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
*/

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

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

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

関数ヘッダーのコメント

/** 
* 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();}

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

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

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

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

/* 生成配置文件、数据文件。*/ 
 
$this->setConfig(); 
$this->createConfigFile(); //创建配置文件 
$this->clearCache();     // 清除缓存文件 
$this->createDataFiles();  // 生成数据文件 
$this->prepareProxys(); 
$this->restart();

PHP 命名規則

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

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

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

クラスのファイル名はすべて名前空間で定義されます。スペースのパスはクラス ライブラリ ファイルのパスと一致します。クラス ファイルはキャメル ケース (最初の文字は大文字) を使用して名前が付けられ、その他のファイルは小文字 + 下線で名前が付けられます。一貫性があり、キャメルケース方式 (最初の文字が大文字) が使用されます

2. 関数とクラス、属性の名前付け

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

tableName、instance などの属性 (最初の文字は小文字) の名前付けにはキャメルケース方式を使用します (現在、属性の最初の文字には小文字を使用するのが一般的です)タイプ)、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ページファイル内のすべてのコメントを削除する方法

JavaScriptでのメソッドとコメントの書き方の詳細な紹介

html、css、jsコメントの標準的な使用法

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