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

コメントはコードを書くプロセスにおいて非常に重要です。良いコメントはコードを読みやすくします。コードを書くときは、コメントの仕様に注意する必要があります。ここに全員向けの概要があります。必要な友達は、参照してください。

HP コメント仕様

コメントはコードを書くプロセスにおいて非常に重要です。良いコメントはコードを読みやすくします。コードを書くときは必ず読んでください。 . コメントの仕様に注意してください。

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

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

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

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

/**
* @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category 组织packages
* @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 はデフォルトでサフィックスを追加する必要はありません。たとえば、UserController は User
として直接名前を付ける必要があります。関数に名前を付けるときは、小文字とアンダースコア (小文字で始まる) を使用します。たとえば、get_client_ip
メソッドに名前を付けるときは、キャメル ケース (最初の文字) を使用します。getUserName など (メソッドに戻り値がある場合は、小文字)、現在、s (文字列)、i (int)、f (float)、b (boolean)、a (array) など、最初の文字が小文字の属性タイプを使用するのが一般的です。)
キャメル ケースの名前付けを使用するtableName、instance などの属性 (最初の文字は小文字) (現在、s (文字列)、i (int)、f (float)、b(boolean など) の最初の文字を小文字の属性タイプを使用するのが一般的です。 )、a(配列)など)
二重アンダースコア「__」で始まる関数またはメソッドは、__callや__autoloadなどのマジックメソッドとして使用されます

3. 定数と設定

定数名は、APP_PATH や THINK_PATH のように、大文字とアンダースコアで名前が付けられます。
構成パラメータは、url_route_on や url_convert など、小文字とアンダースコアで名前が付けられます

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

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

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