techdeco / coding-standard
Frank Koornstra项目编码规范
v1.0.0
2018-02-10 11:14 UTC
Requires
- php: ^7.2
- dealerdirect/phpcodesniffer-composer-installer: ^0.4.2
- doctrine/coding-standard: ^2.1
- slevomat/coding-standard: >=4.4.0 <4.4.4 || >=4.4.5
- squizlabs/php_codesniffer: ^3.2
This package is auto-updated.
Last update: 2020-06-06 00:05:25 UTC
README
自定义PHPCS规则集以标准化项目风格
标准
编码规范基于PSR-1和PSR-2,有一些显著的例外/差异/扩展(✅表示已实现的sniffs)
- 尽可能保持方法中控制结构的嵌套最小
- 优先使用早期退出而不是嵌套条件或使用else
- ✅ 对赋值中的等于(
=)符号进行对齐 - ✅ 在连接运算符周围添加空格
$foo = 'Hello ' . 'World!'; - ✅ 在赋值、控制和返回语句之间添加空格
- ✅ 在否定运算符周围添加空格
if (! $cond) - ✅ 在返回类型声明中的冒号周围添加空格
function () : void {} - ✅ 在类型转换后添加空格
$foo = (int) '12345'; - ✅ 使用撇号包围字符串
- ✅ 总是使用严格比较
- ✅ 总是在文件开头添加
declare(strict_types=1) - ✅ 在可能的情况下总是使用本地类型
- ✅ 对于具有本地类型的参数/返回,除非添加描述,否则省略phpDoc
- ✅ 不要使用
@author、@since和类似的重复Git信息的注释 - ✅ 不允许在条件中赋值
更多信息