PHPのコメント構文の仕様と命名規則の詳細な説明

コメントはコードを書く上で非常に重要です。良いコメントがあるとコードが読みやすくなります。コードを書くときはコメントの仕様に注意する必要があります。ここではスクリプトハウスの編集者が整理します。必要な友達は、

HP コメント仕様を参照してください。

コメントは、コードを書くプロセスにおいて非常に重要です。良いコメントを付けると、コードが読みやすくなります。 . コードを記述する際にはコメントの指定に注意してください。

「PHP は、非常に簡単に始めることができる言語です。始めたばかりの初心者でも、echo を使用して数分以内に hello world を出力できるかもしれません。しかし、彼は本物のプログラマーなのでしょうか? 「どうやって行うのですか? プログラマの定義はどうですか? 本当にプログラマになりたいのなら、一連のプログラム記述仕様に従わなければなりません。」

私たちはいくつかの関数をよく書きますが、これらの関数は理解することしかできません。自分たちで、あるいは自分でも久しぶりに自分が何を書いたか分からなくなってしまったのですが、どうすればいいでしょうか？もちろん、コードにコメントを追加するのが最善の方法です。

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

# は短いコメント メソッドです。おそらく、これを使用して変数に注釈を付けたり、メソッドを呼び出したりすることになるでしょう。 /**/ です。コメントに今でも使用することがあります。コードの大部分を取り出しますが、それを使用して関数に標準的に注釈を付けるにはどうすればよいでしょうか?

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

* @category 組織パッケージ
* @copyright 著作権情報を指定します
* @const 定数を指定します
* @deprecate 非推奨または廃止された情報を指定します
* @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 などのキャメル ケース (最初の文字が大文字) が使用され、デフォルトではサフィックスは必要ありません。 User
という名前を直接付けます。関数の名前は、get_client_ip
のように、小文字とアンダースコア (小文字で始まる) を使用して付けられます。メソッドの名前付けには、getUserName などのキャメル ケース (最初の文字は小文字) が使用されます (メソッドがには戻り値があります。現在、s (文字列)、i (int)、f (float)、b (boolean)、a (array) など、最初の文字が小文字の属性タイプを使用するのが通例です)
tableName、instance など、属性の命名にはキャメル ケースを使用します (最初の文字は小文字です) (現在、s(string )、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 言語のコメント、単一行コメントと複数行コメントの関連コンテンツ

phpstorm の空行とコメント行を削除するための定期的なマッチング

解析ソースコードによる Laravel 依存性注入関連のコンテンツ

#

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