资讯专栏INFORMATION COLUMN

PHP PSR-1 基本代码规范

andot / 2507人阅读

摘要:基本代码规范本篇规范制定了代码基本元素的相关标准,以确保共享的代码间具有较高程度的技术互通性。从属效应一词的意思是,仅仅通过包含文件,不直接声明类函数和常量等,而执行的逻辑操作。及以后版本的代码必须使用正式的命名空间。

基本代码规范

本篇规范制定了代码基本元素的相关标准,
以确保共享的PHP代码间具有较高程度的技术互通性。

关键词 “必须”("MUST")、“一定不可/一定不能”("MUST NOT")、“需要”("REQUIRED")、
“将会”("SHALL")、“不会”("SHALL NOT")、“应该”("SHOULD")、“不该”("SHOULD NOT")、
“推荐”("RECOMMENDED")、“可以”("MAY")和”可选“("OPTIONAL")的详细描述可参见 [RFC 2119][] 。

概览


PHP代码文件必须 标签开始;

PHP代码文件必须不带BOM的 UTF-8 编码;

PHP代码中应该只定义类、函数、常量等声明,或其他会产生 从属效应 的操作(如:生成文件输出以及修改.ini配置文件等),二者只能选其一;

命名空间以及类必须符合 PSR 的自动加载规范:PSR-0[] 中的一个;

类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范;

类中的常量所有字母都必须大写,单词间用下划线分隔;

方法名称必须符合 camelCase 式的小写开头驼峰命名规范。

文件


2.1. PHP标签

PHP代码必须使用 长标签 或 短输出标签;
一定不可使用其它自定义标签。

2.2. 字符编码

PHP代码必须且只可使用不带BOM的UTF-8编码。

2.3. 从属效应(副作用)

一份PHP文件中应该要不就只定义新的声明,如类、函数或常量等不产生从属效应的操作,要不就只有会产生从属效应的逻辑操作,但不该同时具有两者。

“从属效应”(side effects)一词的意思是,仅仅通过包含文件,不直接声明类、
函数和常量等,而执行的逻辑操作。

“从属效应”包含却不仅限于:生成输出、直接的 requireinclude、连接外部服务、修改 ini 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。

以下是一个反例,一份包含声明以及产生从属效应的代码:


";

// 声明函数
function foo()
{
    // 函数主体部分
}

下面是一个范例,一份只包含声明不产生从属效应的代码:


命名空间和类


命名空间以及类的命名必须遵循 [PSR-0][].

根据规范,每个类都独立为一个文件,且命名空间至少有一个层次:顶级的组织名称(vendor name)。

类的命名必须 遵循 StudlyCaps 大写开头的驼峰命名规范。

PHP 5.3及以后版本的代码必须使用正式的命名空间。

例如:


5.2.x及之前的版本应该使用伪命名空间的写法,约定俗成使用顶级的组织名称(vendor name)如 Vendor_ 为类前缀。


类的常量、属性和方法


此处的“类”指代所有的类、接口以及可复用代码块(traits)

4.1. 常量

类的常量中所有字母都必须大写,词间以下划线分隔。
参照以下代码:


4.2. 属性

类的属性命名可以遵循 大写开头的驼峰式 ($StudlyCaps)、小写开头的驼峰式 ($camelCase) 又或者是 下划线分隔式 ($under_score),本规范不做强制要求,但无论遵循哪种命名方式,都应该在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。

4.3. 方法

方法名称必须符合 camelCase() 式的小写开头驼峰命名规范。

转自Github(PizzaLiu)

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/21162.html

相关文章

  • PHPPSR简要规范

    摘要:是一系列关于开发的规范,分有好几个版本,自己学的也较为肤浅,但还是希望能时常查看规范,为了方便记忆和遵循,我把关键词为必须的捡拾出来,做个简单地必要规范的记录。所有文件必须使用作为行的结束符。 PSR是一系列关于PHP开发的规范,分有好几个版本,自己学的也较为肤浅,但还是希望能时常查看规范,为了方便记忆和遵循,我把关键词为必须的捡拾出来,做个简单地必要规范的记录。(就是个搬砖的。。。)...

    Steve_Wang_ 评论0 收藏0
  • PHP 规范PSR规范

    摘要:参考自动加载已废弃基本代码规范代码样式日志接口如何指定文件路径从而自动加载类定义基本代码规范本篇规范制定了代码基本元素的相关标准,以确保共享的代码间具有较高程度的技术互通性。 概述 PSR 不是PHP官方标准,而是从如Zend、Symfony2等知名PHP项目中提炼出来的一系列标准,目前有越来越多的社区项目加入并遵循该标准。 参考:http://psr.phphub.org/ PSR-...

    BothEyes1993 评论0 收藏0
  • PHP PSR规范

    摘要:前言试问现在的码农对规范了解多少。写了几年代码的我,居然因不了解规范被鄙视特此来交下学费网上资料有很多,本文只做链接指引什么是是的简称,这个是组织制定的一套规范。 前言 试问现在php的码农对psr规范了解多少。 写了几年代码的我,居然因不了解规范被鄙视!特此来交下学费 网上资料有很多,本文只做链接指引 什么是PSR PSR是PHP Standards Recommendatio...

    weknow619 评论0 收藏0
  • PHP-PSR 现代PHPer的开发规范

    摘要:的使命是实现框架之间的互操作性。个人和官方都认为开发者应该遵循更为严格的代码标准,在现代的生态系统中,风格统一,可以更好的让其他开发者理解代码。记录的消息用于诊断检查和排除应用中的操作稳定性和性能方面的问题。 原文是在我自己博客中,小伙伴也可以点阅读原文进行跳转查看,还有好听的背景音乐噢~     PSR是PHP Standards Recommendation的简称,意为PHP推荐标...

    zebrayoung 评论0 收藏0
  • PSR-4——新鲜出炉的PHP规范

    摘要:制定的规范,简称,是开发的事实标准。原本有四个规范,分别是自动加载基本代码规范代码样式日志接口年底,新出了第个规范。区别在于的规范比较干净,去除了兼容以前版本的内容,有一点升级版的感觉。 FIG制定的PHP规范,简称PSR,是PHP开发的事实标准。 PSR原本有四个规范,分别是: PSR-0 自动加载 PSR-1 基本代码规范 PSR-2 代码样式 PSR-3 日志接口 20...

    Fundebug 评论0 收藏0
  • 在github规范开发以及持续构建php项目

    摘要:本文目的是通过自己写的一个的简单的库花密密码生成工具,来学习我认为的库开发的一些规范,以及上持续构建你的项目的一些方法。给自己的项目开启持续构建。包发布以及当你的代码完成后,测试完成后。 本文目的是通过自己写的一个php的简单的库(花密密码生成工具), 来学习我认为的php库开发的一些规范,以及github上持续构建你的项目的一些方法。其实是为了显示下边一系列的的徽章 showImg(...

    Sleepy 评论0 收藏0

发表评论

0条评论

andot

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<