电脑知识|欧美黑人一区二区三区|软件|欧美黑人一级爽快片淫片高清|系统|欧美黑人狂野猛交老妇|数据库|服务器|编程开发|网络运营|知识问答|技术教程文章 - 好吧啦网

您的位置:首頁技術文章
文章詳情頁

PHP 編碼規范及建議

瀏覽:87日期:2022-09-11 14:40:24

最近又在推動公司內部PHPer們代碼規范化,今天我整理了一下貼出來以供大家參考。

編碼規范 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.phpclass A{}b.phpfunction demo(){}c.phpdefine(’A’, value);d.phpini_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 TestTestClass;//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 = <<<SQLSELECT delivery_idFROM d_testWHERE delivery_idIN (123,234)GROUP BY delivery_idHAVING 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為doSomethingclass 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>// +----------------------------------------------------------------------

來自:http://tigerb.cn/2017/03/06/standard/

標簽: PHP
相關文章:
主站蜘蛛池模板: 平面钻,法兰钻,三维钻-山东兴田阳光智能装备股份有限公司 | 北京乾茂兴业科技发展有限公司 | 电脑知识|软件|系统|数据库|服务器|编程开发|网络运营|知识问答|技术教程文章 - 好吧啦网 | 透平油真空滤油机-变压器油板框滤油机-滤油车-华之源过滤设备 | 网站建设,北京网站建设,北京网站建设公司,网站系统开发,北京网站制作公司,响应式网站,做网站公司,海淀做网站,朝阳做网站,昌平做网站,建站公司 | 工控机-工业平板电脑-研华工控机-研越无风扇嵌入式box工控机 | Magnescale探规,Magnescale磁栅尺,Magnescale传感器,Magnescale测厚仪,Mitutoyo光栅尺,笔式位移传感器-苏州连达精密量仪有限公司 | 自动检重秤-动态称重机-重量分选秤-苏州金钻称重设备系统开发有限公司 | 珠海网站建设_响应网站建设_珠海建站公司_珠海网站设计与制作_珠海网讯互联 | 衡阳耐适防护科技有限公司——威仕盾焊接防护用品官网/焊工手套/焊接防护服/皮革防护手套 | 国际船舶网 - 船厂、船舶、造船、船舶设备、航运及海洋工程等相关行业综合信息平台 | 南京展台搭建-南京展会设计-南京展览设计公司-南京展厅展示设计-南京汇雅展览工程有限公司 | 水冷散热器_水冷电子散热器_大功率散热器_水冷板散热器厂家-河源市恒光辉散热器有限公司 | 中矗模型-深圳中矗模型设计有限公司 | 河南卓美创业科技有限公司-河南卓美防雷公司-防雷接地-防雷工程-重庆避雷针-避雷器-防雷检测-避雷带-避雷针-避雷塔、机房防雷、古建筑防雷等-山西防雷公司 | 钢骨架轻型板_膨石轻型板_钢骨架轻型板价格_恒道新材料 | 一体化污水处理设备-一体化净水设备-「山东梦之洁水处理」 | 车充外壳,车载充电器外壳,车载点烟器外壳,点烟器连接头,旅行充充电器外壳,手机充电器外壳,深圳市华科达塑胶五金有限公司 | 郑州巴特熔体泵有限公司专业的熔体泵,熔体齿轮泵与换网器生产厂家 | 塑胶跑道施工-硅pu篮球场施工-塑胶网球场建造-丙烯酸球场材料厂家-奥茵 | 土壤养分检测仪_肥料养分检测仪_土壤水分检测仪-山东莱恩德仪器 大型多片锯,圆木多片锯,方木多片锯,板材多片锯-祥富机械有限公司 | 冻干机(冷冻干燥机)_小型|实验型|食品真空冷冻干燥机-松源 | 北京模型公司-军事模型-工业模型制作-北京百艺模型沙盘公司 | 创绿家招商加盟网-除甲醛加盟-甲醛治理加盟-室内除甲醛加盟-创绿家招商官网 | 污水处理设备,一体化泵站,一体化净水设备-「梦之洁环保设备厂家」 | 深圳办公室装修,办公楼/写字楼装修设计,一级资质 - ADD写艺 | (中山|佛山|江门)环氧地坪漆,停车场地板漆,车库地板漆,聚氨酯地板漆-中山永旺地坪漆厂家 | 网站seo优化_seo云优化_搜索引擎seo_启新网络服务中心 | 宝宝药浴-产后药浴-药浴加盟-艾裕-专注母婴调养泡浴 | 一体化污水处理设备_生活污水处理设备_全自动加药装置厂家-明基环保 | 耐高温风管_耐高温软管_食品级软管_吸尘管_钢丝软管_卫生级软管_塑料波纹管-东莞市鑫翔宇软管有限公司 | 二手回收公司_销毁处理公司_设备回收公司-找回收信息网 | 上海网站建设-上海网站制作-上海网站设计-上海做网站公司-咏熠软件 | 塑胶跑道_学校塑胶跑道_塑胶球场_运动场材料厂家_中国塑胶跑道十大生产厂家_混合型塑胶跑道_透气型塑胶跑道-广东绿晨体育设施有限公司 | 天津力值检测-天津管道检测-天津天诚工程检测技术有限公司 | 北钻固控设备|石油钻采设备-石油固控设备厂家 | 杭州货架订做_组合货架公司_货位式货架_贯通式_重型仓储_工厂货架_货架销售厂家_杭州永诚货架有限公司 | 山东商品混凝土搅拌楼-环保型搅拌站-拌合站-分体仓-搅拌机厂家-天宇 | 刚性-柔性防水套管-橡胶伸缩接头-波纹管补偿器-启腾供水材料有限公司 | 斗式提升机_链式斗提机_带式斗提机厂家无锡市鸿诚输送机械有限公司 | CCC验厂-家用电器|服务器CCC认证咨询-奥测世纪 |