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

如果您在编写PHP函数时发现格式混乱、注释缺失或与团队代码风格不一致,则可能是未严格遵循PSR-12对函数结构和文档注释的强制性要求。以下是依据PSR-12标准落实函数排版与注释规范的具体操作步骤:
一、函数声明的排版规范
PSR-12明确规定函数声明必须保持视觉清晰、缩进统一、括号位置固定,以消除解析歧义并提升跨项目可读性。所有函数必须使用4个空格缩进,左花括号不得换行,参数列表需合理换行对齐。
1、函数关键字function与其后括号之间**不得有空格**,如function myFunction()而非function myFunction ()。
2、参数列表若超过单行80字符限制,应逐个参数换行,并对齐至第一个参数的起始列,每个参数独占一行,末尾逗号置于行尾。
立即学习“PHP免费学习笔记(深入)”;
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语句应紧接上一行逻辑代码之后。
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)。



















