您好,欢迎访问一九零五行业门户网

新手PHP 编码规范及建议

想要当一名出色的程序员,一手好的代码规范是很重要的,那么如何才能写出一手好代码呢?本文我们就给大家一些php 编码规范及建议。
编码规范php代码文件必须以 <?php 标签开始。
<?php //开头 // 不结尾
php代码文件必须以不带bom的utf-8编码。
例sublime, setting增加,"show_encoding" : true
每行的字符数不超过 80 个字符
例,sublime "word_wrap": "true", "wrap_width": 80,
tap键4个空格
例,sublime "tab_size": 4,
php代码中应该只定义类(trait)/函数/常量/其他会产生副作用的操作(如:生成文件输出以及修改 .ini 配置文件等),只能选其一。
例, a.php class a { } b.php function demo() { } c.php define('a', value); d.php ini_set('some_vars', value);
类/trait/interface的命名必须遵循 studlycaps 大写开头的驼峰命名规范。
class studlycaps { } trait studlycaps { } interface studlycaps { }
类中的常量所有字母都必须大写,单词间用下划线分隔。
define('foo_bar', 'something more'); const foo_bar = value;
方法(类/trait中)名称必须符合 camelcase 式的小写开头驼峰命名规范。
class studlycaps { public function studlycaps() { // coding... } }
函数名称必须符合 snake_case 式的下划线式命名规范。
function snake_case() { // coding... }
私有的(private)方法(类/trait中)名称必须符合 _camelcase 式的前置下划线小写开头驼峰命名规范。
class studlycaps { private function _studlycaps() { // coding... } }
方法名称 第一个单词 为动词。
class studlycaps { public function dosomething() { // coding... } }
变量 必须符合 camelcase 式的小写开头驼峰命名规范。
class studlycaps { public function dosomething() { $somevariable = 'demo'; // coding... } }
方法/函数 多参数时,之间要有1个空格
class studlycaps { public function dosomething($variableone, $variabletwo) { // coding... } }
运算符/表达式 要有一个空格
$a = $b + $c; $a = $b . $c;
每个 namespace 命名空间声明语句块 和 use 声明语句块后面,必须 插入一个空白行。
namespace standard; // 空一行 use test\testclass;//use引入类 // 空一行
类的开始花括号 “{ “必须 写在函数声明后自成一行,结束花括号”}”也必须写在函数主体后自成一行。
class studlycaps { }
方法/函数的开始花括号 { 必须 写在函数声明后自成一行,结束花括号 }也 必须 写在函数主体后自成一行。
class studlycaps { public function studlycaps() { // coding... } } function snake_case() { // coding... }
类的属性和方法 必须 添加访问修饰符(private、protected 以及 public),abstract 以及 final 必须 声明在访问修饰符之前,而 static 必须 声明在访问修饰符之后。
abstract class studlycaps { abstract public function studlycaps(); final public static function studlycapsone() { } }
控制结构的关键字后 必须 要有一个空格符,而调用方法或函数时则 一定不可 有。
if ($valueone === $valuetwo) { // code... } switch ($valuethree) { case 'value': // code... break; default: // code... break; } do { // code... } while ($valuefour <= 10); while ($valuefive <= 10) { // code... } for ($i = 0; $i < $valuesix; $i++) { // code... } $demo = new demo() $demo->dosomething(); do_something();
控制结构的开始花括号 { 必须 写在声明的同一行,而结束花括号 } 必须 写在主体后自成一行。
if ($valueone === $valuetwo) {   // code... } switch ($valuethree) {   case 'value':     // code...     break;   default:     // code...     break; } do {   // code... } while ($valuefour <= 10); while ($valuefive <= 10) { // code... } for ($i = 0; $i < $valuesix; $i++) { // code... }
控制结构的开始左括号后和结束右括号前,都一定不可有空格符。
if ($valueone === $valuetwo) {// 控制结构(右边和)左边不加空格 // code... }
编码建议sql过长
// heredoc语法 $sql = <<<sql select delivery_id from d_test where delivery_id in (123,234) group by delivery_id having sum(send_number) <= 0; sql;
if等控制结构条件过长
if ($a > 0     && $b > 0     && $c > 0     && $d > 0     && $e > 0) { }
方法或函数参数大于三个换行
public function toolangfunction(       $valueone   = '',       $valuetwo   = '',       $valuethree = '',       $valuefour  = '',       $valuefive  = '',       $valuesix   = '') {     //coding... }
链式操作超过两个
$this->nametest->functionone()                ->functiontwo()                ->functionthree();
数组php5.4以后,使用[]
$a = [     'aaa' => 'aaa',     'bbb' => 'bbb' ];
单引号多引号
字符串中无变量,单引号
字符串中有变量,双引号
$str = 'str'; $arg = $str;
声明类或者方法或函数添加描述&属性描述&作者
/**  * 类描述  *  * desc  */ class standardexample {   /**    *  常量描述.    *    * @var string    */   const this_is_a_const = '';   /**    * 属性描述.    *    * @var string    */   public $nametest = '';   /**    * 构造函数.    *    * 构造函数描述    * @author name <email>    * @param  string $value 形参名称/描述    * @return 返回值类型        返回值描述    * 返回值类型:string,array,object,mixed(多种,不确定的),void(无返回值)    */   public function __construct($value = '')   {     // coding...   }
api方法提供测试样例example
/**  * 成员方法名称.  *  * 成员方法描述  *  * @param  string $value 形参名称/描述  *  * @example domain/api/controller/action?argu1=111&argu2=222  */ public function testfunction($value = '') {     // code... }
使用try…catch…
try {     // coding... } catch (\exception $e) {   // coding... }
连续调用多个方法(大于3个)使用foreach
// 改写dosome为dosomething class standardexample {   /**    * 方法列表    *    * @var array    */   private $_functionlist = [];   public function __construct($functionlist = array())   {     $this->_functionlist = $value;   }   public function dosome()   {     $this->functionone();     $this->functiontwo();     $this->functionthree();     $this->functionfour();   }   public function dosomething()   {       foreach($this->_functionlist as $function) {           $this->$function();       }   }   ... }
文件顶部进行版权声明
// +---------------------------------------------------------------------- // | company name  xx服务 // +---------------------------------------------------------------------- // | copyright (c) 2017 http://domain all rights reserved. // +---------------------------------------------------------------------- // | author: name <email> // +----------------------------------------------------------------------
以上内容就给新手程序员的一些编写代码的规范及建议,希望能帮助到大家。
相关推荐:
怎样优化自己的javascript代码
php 代码的复用简单教程
php 代码规范
以上就是新手php 编码规范及建议的详细内容。
其它类似信息

推荐信息