乐趣区

关于php:参考这个PHP代码规范后同事都夸你的代码写的棒极了

jiezi

为什么须要编码标准

一个好的编码习惯靠平时的习惯养成，团队里有好的编码标准，并且每个人都依照制订的编码标准来执行，那么我置信代码的品质以及可维护性会回升一个品位。而目前 PHP 要求都要恪守 PSR 标准规范，我只列举一部分编码中罕用的写法进行阐明，更多的标准大家能够搜寻PSR 规范。

PHP 文件开始标签

对于纯 PHP 的代码文件，必须以 <?php 或者<? 标签开始，并且独占一行，同时不要加 ?> 的完结标签，至于为啥，感兴趣的本人去理解哈。

<?php

class TestDemo
{}

Class 类的申明

类名必须以大写结尾的驼峰式命名(TestDemo)，两个花括号换行且独占一行，同时须要用多行正文阐明类的创建人以及作用等。

/**
 * 这是一个测试 Demo 类
 * Author: gxcuizy
 * Date: 2021-05-25 13:57:16
 * Class TestClass
 */
class TestDemo
{}

Class 类的常量

类中的常量命名必须全副字母都要大写 (HELLO_WORLD)，同时单词间以下划线_ 分隔，而且最好减少正文阐明，单行正文最好在 // 后先加一个空格再接正文阐明。

// 申明一个常量
const HELLO_WORLD = 'best';

Class 类的成员属性

类中的成员属性（也叫成员变量），成员属性的命名能够遵循三个规定：大写结尾的驼峰式 ($UserName)、小写结尾的驼峰式($userName)、下划线分隔式($user_name)；这三种命名规定都能够，我集体习惯用 下划线分隔式，大家也能够依据本人的习惯抉择，然而最好与团队编码规定保持一致即可，同时三个修饰符（public、protected、private）不能少。

// 申明一个公共变量
public $user_name = '';
// 申明一个动态变量
public static $user_age = 18;

Class 类的成员办法

类中的成员办法的命名必须采纳小写结尾的驼峰式命名 (testAction) 规定，办法的三个修饰符（public、protected、private）不能少，两个花括号换行且独占一行，参数的等号两边各一个空格，办法的正文不要漏了哈，包含办法的作用、参数阐明以及返回值阐明等。

/**
 * 这是一个测试方法
 * @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 '未成年';}
}

疾速一键格式化

当初很多 IDE 都反对一键格式化代码，比方 PhpStorm 等，个别快捷键都是Ctrl + Alt + L，你也能够依据你本人的习惯进行批改快捷键以及代码格局的规范，既能够一键格式化整个文档，也能够只选中某一部分代码进行格式化。PS：如果这个文件不是你一个人创立和批改，请不要轻易一键格式化整个文件，因为会把人家的代码也给格式化了，举荐只格式化你本人的代码即可，每个人都不喜爱他人随便动本人的代码，所以不要搞事件！不要搞事件！不要搞事件！重要的事件说三遍，你懂的。

最初总结

先给出集体的几点倡议吧，心愿对你有所帮忙：

  • 别加多余的空格，也就是该加一个空格就加一个就行（依照代码标准来就行）
  • 多余的换行删除掉（影响代码视觉好看）
  • 调试代码记得及时删除，而不仅仅是正文（怕你长此以往就忘了）
  • 代码正文，代码正文，代码正文（再忙也要适当的写正文，不要说前面再加）
  • 你能够看不爽他人的代码，然而不要随便批改他人的代码（因为他人看你的代码也不爽）
  • 欢送补充……

我只是抽取了一小部分罕用到的代码标准说一下，如果有写的不对的中央请大家指出，我会及时批改，谢谢。如果你还有其余好的编码技巧，也欢送和大家一起分享。

退出移动版