PHP コメント構文の仕様と命名規則-php手册-php.cn

PHP コメント構文の仕様と命名規則

WBOY

リリース： 2018-09-27 14:34:08

オリジナル

3017 人が閲覧しました

コメントはコードを書く過程において非常に重要です。良いコメントはコードを読みやすくします。コードを書くときは、コメントの仕様に注意する必要があります。ここでは、スクリプトハウスの編集者がそれを整理します。困っている友達は参考にしてください。

hp コメントの仕様

コメントは作成プロセスにおいて非常に重要です。コードを記述する際には、コメントの仕様に注意してください。

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

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

私たちは c pear 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 (ブール値)、a (配列) など)
二重アンダースコア「__」で始まる関数またはメソッドは、__call や __autoload などのマジックメソッドとして使用されます。

3. 定数と構成

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

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

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