tzachi / coding-standard
TZachi项目编码规范
0.1.1
2019-04-21 10:12 UTC
Requires
- php: ^7.1
- doctrine/coding-standard: ^6.0
Requires (Dev)
- roave/security-advisories: dev-master
This package is auto-updated.
Last update: 2024-09-25 06:57:51 UTC
README
此项目包含一组基于 PHP_CodeSniffer 规则的规则,基于 doctrine/coding-standard 规则,但有一些小的更改和添加。
与 doctrine 编码规范的区别
- 行内注释应以空格开头,例如:
// 这是一个行内注释 - Docblock注释组的分组方式略有不同
- try...catch 中的空 catch 必须有注释说明为什么没有处理异常
- 否定运算符
if (!$cond)后面不应有空格 - 返回类型前的冒号前不应有空格:
public function test(): void - 属性文档注释不应为单行,而应为多行
/** * @var int */
- 变量/属性/函数名称应使用驼峰命名法:
$camelCaseVariable - @throw 标签注释不需要以句号结尾
class Abc { /** * @throw InvalidArgumentException This is a comment that doesn't end in a full stop */ public function def(): void { ... }