美しいPHPコードの書き方
- 醉折花枝作酒筹転載
- 2021-07-06 15:33:451956ブラウズ
良いコーディング習慣は日々の習慣によって培われますが、チーム内で良いコーディング標準があり、全員がそれを遵守することで、コードの品質や保守性はより高いレベルに上がると思います。現在、PHP は PSR 規格に準拠することが求められていますが、コーディングの際によく使われる記述方法のみを列挙して説明します。詳しい仕様については、PSR 規格を検索してください。
PHP ファイルの開始タグ
純粋な PHP コード ファイルの場合、e7e0002b2b0f2b8286ec0af4ca86253b の終了タグは付けないでください。理由は興味があればご自身で調べてください。
<?php
class TestDemo
{
}クラス class の宣言
クラス名は、大文字で始まるキャメル ケース (TestDemo) で名前を付ける必要があります。2 つの中括弧はラップされ、1 行を占めます。クラスの作成、人物や機能などを説明するには複数行のコメントが必要です。
/**
* 这是一个测试Demo类
* Author: gxcuizy
* Date: 2021-05-25 13:57:16
* Class TestClass
*/
class TestDemo
{
}クラス class の定数
クラス内の定数名はすべて大文字 (HELLO_WORLD) にする必要があり、単語はアンダースコア _ で区切られ、コメントを追加することをお勧めします。単一行のコメントが最適です。幸いなことに、// の後にスペースを追加してからコメントを追加してください。
// 声明一个常量 const HELLO_WORLD = 'best';
クラスのメンバー属性 class
クラスのメンバー属性 (メンバー変数とも呼ばれます)、メンバー属性の命名は 3 つのルールに従うことができます: 大文字 ($UserName) で始まるキャメルケース、キャメル ケース ($userName) と小文字の先頭のアンダースコア区切り ($user_name) の 3 つの命名規則はすべて受け入れられます。私は個人的にアンダースコア区切りタイプを使用します。自分の習慣に応じて選択することもできますが、それがベストですチームのコーディング ルールに同意するため、一貫性を保ち、3 つの修飾子 (public、protected、private) を省略することはできません。
// 声明一个公共变量 public $user_name = ''; // 声明一个静态变量 public static $user_age = 18;
クラス class のメンバー メソッド
クラス内のメンバー メソッドの命名には、小文字で始まるキャメル ケースの命名規則 (testAction) と、メソッドの 3 つの修飾子 (public、 protected, private ) が欠落していてはなりません。2 つの中括弧で囲んで 1 行を占有する必要があります。パラメーターの等号の両側にはスペースが必要です。メソッドに関するコメント (関数を含む) を見逃さないでください。メソッド、パラメータの説明、戻り値の説明など。
/**
* 这是一个测试方法
* @param string $msg 参数说明
* @return array
*/
public function testAction($msg = '')
{
// 返回数据格式
$return = array('code' => 200, 'msg' => '');
return $return;
}
/**
* 这是私有方法，方法命名以单下划线开始
* @param string $arg 参数说明
* @return string
*/
private function privateAction($arg = '')
{
return $arg;
}演算子と式
さまざまなタイプの演算子や式に関しては、どこで使用されるかに関係なく、$a = などの記号の両側にスペースを入れる必要があります。 1;、1 2、1 && 0 など
/**
* 获取两个数相加的和
* @param int $one 第一个数
* @param int $two 第二个数
* @return int
*/
public function getUserAge($one = 0, $two = 0)
{
$sum = $one + $two;
return $sum;
}制御構造の標準的な書き方
if...else、while、switch...case、foreach、for、およびその他のプロセス制御構造と同様に、これらは基本的に以下と組み合わせる必要があります。大括弧 () と中括弧 { } が一緒に使用されているため、大括弧 () の両側にスペースが必要です。また、左中括弧 {右大括弧と一緒に使用する必要があります) と右中括弧} にはスペースが必要です。は別の行に置く必要があり、メインのコンテンツは中かっこ {} で囲まれます。
/**
* 判断用户是否成年
* @param int $age 年龄
*/
public function logicAction($age = 18)
{
if ($age >= 18) {
echo '已成年';
} else {
echo '未成年';
}
}クイック ワンクリック フォーマット
PhpStorm など、多くの IDE がコードのワンクリック フォーマットをサポートするようになりました。一般的なショートカット キーは Ctrl Alt L ですが、必要に応じて使用することもできます。ショートカット キーとコード形式標準を変更する ワンクリックで文書全体を書式設定することも、コードの特定の部分のみを選択して書式設定することもできます。 PS: このファイルが自分だけで作成および変更されていない場合は、他の人のコードもフォーマットしてしまうため、ワンクリックでファイル全体を簡単にフォーマットしないでください。自分のコードのみをフォーマットすることをお勧めします。他の人が私のコードを自由にいじれるので、トラブルを起こさないでください。トラブルを起こさないでください！トラブルを起こさないでください！大事なことは3回言いましょう。
最終まとめ
まず、個人的な提案をいくつかさせていただきます。お役に立てば幸いです。
余分なスペースは追加しないでください。必要に応じてスペースを追加するだけです (コードの仕様に従ってください)
余分な改行を削除します (コードの見た目の美しさに影響します)
コメントだけでなく、デバッグ コードも時間内に忘れずに削除してください (時間が経つと忘れてしまうでしょう)
コード コメント、コード コメント、コード コメント (どんなに忙しくても、コメントは適切に書くべきです。後から追加しないでください)
他の人のコードを見下すことはできますが、他の人のコードを変更しないでください。 (他の人があなたのコードを見ると気分が良くないからです)
ここでは、一般的に使用されるコード仕様のほんの一部を抜粋して説明しました。執筆中ですので、ご指摘いただけましたら、時間内に修正させていただきます。ありがとうございます。他に優れたコーディング スキルをお持ちの場合は、ぜひそれをみんなと共有してください。
推奨学習: php ビデオ チュートリアル
以上が美しいPHPコードの書き方の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。