首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

PSR-1:基本编码规范

一、能愿动词

MUST 必须

MUST NOT 一定不能

SHOULD 应该

SHOULD NOT 不应该

二、概览

文件必须(MUST)只用或者标签。

php代码必须使用编码。

文件只用于声明符号(),例如类,方法,常量等,或者只用来做有边际影响的事(),例如创建输出,修改配置文件等,但是同时做这两件事。

命名空间和类遵循一个“自动加载”规范:[PSR-0, PSR-4]。

类名称声明为的形式,即名称中每个单词首字母大写。

类常量只使用大写字母,用下划线来做单词间隔离。

方法名称声明为的形式。

三、文件

php标签

php代码使用标签或者短输出标签;使用其他类型的标签。

字符编码

php代码必须使用编码。

边际影响

一个文件用来定义新符号(类, 方法, 常量等)并且不会带来,或者它执行可能带来的逻辑代码,但是同时做这两件事。

意思是业务代码的执行不会直接涉及到声明类,方法,常量等,而是仅仅来自包含文件。

包含但是不限于:创建输出,明确的使用或者,连接外部服务修改配置文件,抛出错误或者异常,修改全局或者静态变量,从文件读取或者写入文件等等。

下面是一个同时包含声明和边际影响的例子;

换句话说,一个应该避免的例子:

下面是一个包含声明但是没有边际影响的例子;也就是说,一个应该被效仿的例子:

四、命名空间和类名称

命名空间和类遵循一个“自动加载”规范:[PSR-0, PSR-4]。

这意味着每一个类在一个单独的文件中,并且在至少一个层级的命名空间中:一个顶级的包名称。

类名称必须声明为的形式。

php5.3以及以后版本的代码使用正式的命名空间。

例如:

php5.2.x及以前的版本应该使用虚拟命名空间惯例,将前缀添加到类名称前。

五、类常量,属性和类方法

术语“类”指所有类,接口和trait

常量

类常量使用大写字母定义,使用下划线来分隔单词。

例如:

属性

这个指导将回避使用,,还是属性命名的争论。

无论使用任何命名习惯,在一个合理的范围应该被保持一致。这个合理的范围可能是vendor级别,包级别,类级别或者方法级别。

方法

方法名称应该声明为的形式。

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20181006G1OKDC00?refer=cp_1026
  • 腾讯「腾讯云开发者社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 cloudcommunity@tencent.com 删除。

扫码

添加站长 进交流群

领取专属 10元无门槛券

私享最新 技术干货

扫码加入开发者社群
领券