PHP代码规范:PSR-12标准下的函数排版与注释规范

梦明姑娘_7068

梦明姑娘_7068

2026-05-06

499人浏览

原创

PSR-12要求PHP函数严格遵循排版、注释、空行及类型声明规范:函数声明须4空格缩进、左花括号同行、参数对齐换行;PHPDoc必须正上方、单句首行、@param/@return顺序准确;内联注释独立成行,return前禁空行;参数与返回类型必须显式声明,可空类型用?Type,文件首行需declare(strict_types=1)。

php代码规范:psr-12标准下的函数排版与注释规范

如果您在编写PHP函数时发现格式混乱、注释缺失或与团队代码风格不一致,则可能是未严格遵循PSR-12对函数结构和文档注释的强制性要求。以下是依据PSR-12标准落实函数排版与注释规范的具体操作步骤:

一、函数声明的排版规范

PSR-12明确规定函数声明必须保持视觉清晰、缩进统一、括号位置固定,以消除解析歧义并提升跨项目可读性。所有函数必须使用4个空格缩进,左花括号不得换行,参数列表需合理换行对齐。

1、函数关键字function与其后括号之间**不得有空格**,如function myFunction()而非function myFunction ()。

2、参数列表若超过单行80字符限制,应逐个参数换行,并对齐至第一个参数的起始列,每个参数独占一行,末尾逗号置于行尾。

3、函数返回类型声明(冒号后)须紧贴右括号,冒号前后各保留一个空格,如): int而非):int或): int。

4、函数体左花括号{必须与function声明**位于同一行末尾**,且其后必须换行并缩进4个空格开始函数逻辑。

二、PHPDoc文档注释的强制结构

PSR-12要求所有公共方法、函数及类成员必须配备完整PHPDoc块,且注释位置、标签顺序、类型标注均需符合标准化格式,确保静态分析工具(如PHPStan、phpcs)能准确识别接口契约。

1、PHPDoc块必须置于函数声明**正上方**,且与函数之间**不得插入空行**。

2、首行描述必须为单句概括性语句,以大写字母开头,以句号结尾,如“Calculates total price including tax.”。

3、@param标签必须按参数声明顺序逐一列出,类型声明需精确到基础类型或联合类型(如string|int),变量名与类型间用空格分隔。

4、@return标签必须明确标注返回类型,void类型不可省略,禁止使用mixed或any等模糊类型;若函数可返回null,须写作?string等形式。

三、内联注释与空行控制规则

PSR-12限制非必要注释的使用频次,强调通过命名与结构传达意图,仅允许在逻辑转折点、边界条件或非常规实现处添加解释性内联注释,并严格约束空行分布以维持紧凑结构。

1、单行注释//必须独立成行,不得附着于代码行末尾;注释内容前需缩进至与对应代码相同层级。

2、函数体内**禁止在return语句前插入空行**,return语句应紧接上一行逻辑代码之后。

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载

3、多个连续if/elseif/else分支之间**不得插入空行**,但每个分支内部若含多行逻辑,可在语义分组间用单空行分隔。

4、函数定义之间**必须用且仅用一个空行**分隔,禁止连续两个空行或无空行连接。

四、类型声明与可空性标注一致性

PSR-12将类型声明视为函数签名不可分割的部分,要求参数类型、返回类型、可空标记(?)全部显式声明,并与实际运行行为严格一致,避免隐式类型转换引发的维护陷阱。

1、所有参数必须声明类型,禁止省略类型提示(PHP 7.0+环境),如function process(string $data, int $limit)。

2、可空参数必须在类型前加问号,且问号与类型间**不得有空格**,如?string而非? string或?string。

3、返回类型若支持null,必须使用可空语法?Type,禁止混用null作为返回值类型或在@return中单独写null。

4、严格类型模式declare(strict_types=1)必须在文件顶部声明,且该声明**必须位于

五、箭头函数与短闭包的特殊排版

PSR-12针对PHP 7.4+引入的箭头函数定义了专属格式规则,强调其简洁性与表达式本质,禁止将其用于多语句逻辑,且对括号、箭头、返回值的位置作出刚性约束。

1、箭头函数必须使用fn关键字声明,fn与其后括号间**不得有空格**,如fn($x) => $x * 2。

2、单参数时括号可省略,但**仅限单一标识符参数**,如fn($id) => $this->find($id)不可简写为fn$id => …。

3、箭头函数体必须为**单个表达式**,禁止包含语句(如if、foreach)、赋值操作或多个分号分隔的子表达式。

4、当箭头函数作为参数传入高阶函数时,若整体超长,应将fn关键字与括号置于新行,箭头=>与表达式另起一行并缩进4空格,如:array_map(fn($item) => trim($item), $list)。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

12144

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6941

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2215

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4428

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

5134

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

4031

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5837

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4582

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12402

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习