psr-2 是一种 php 代码风格指南,包含以下编写 php 函数的建议:小写函数名,单词间用下划线分隔可选返回类型声明(php 7+)小写参数名,单词间用下划线分隔,可包含默认值代码块始终使用大括号,即使只有一条语句使用 tab 或 4 个空格缩进,确保缩进一致
如何编写一个使用 PSR-2 标准的 PHP 函数
什么是 PSR-2?
PSR-2(PHP 风格指南)是一组针对 PHP 代码风格和格式的推荐惯例,旨在改善代码的可读性和一致性。
立即学习“PHP免费学习笔记(深入)”;
编写 PSR-2 函数
1. 命名规则
-
函数名应使用小写字母,单词间可用下划线分隔。
1
function
get_current_timestamp() { ... }
2. 返回类型(可选)
-
如果函数返回特定的数据类型,可以在函数名前声明返回类型(PHP 7+):
1
function
get_user_role(): string { ... }
3. 参数列表
- 参数名应使用小写字母,单词间可用下划线分隔。
-
参数可以包含可选默认值。
1
function
send_email(string
$to
, string
$subject
, string
$body
=
''
) { ... }
4. 代码块(大括号)
-
函数代码块始终使用大括号,即使只有一条语句。
1
2
3
function
calculate_total_amount() {
return
$quantity
*
$unit_price
;
}
5. 缩进(TAB 或 4 个空格)
- 代码应使用 Tab 或 4 个空格缩进,确保缩进一致。
实战案例
1 2 3 4 5 6 7 8 9 10 |
|
通过遵循 PSR-2 标准,您的 PHP 函数将具有可读性和一致性,便于团队协作和代码维护。