shipito/coding-standard

此包已被废弃，不再维护。没有建议的替代包。

Shipito PHP 编码规范

维护者

详细信息

github.com/Shipito/php-coding-standard

源代码

问题

安装: 385

依赖: 1

建议者: 0

安全: 0

星级: 0

关注者: 4

分支: 0

开放问题: 0

0.6.0 2016-11-07 11:58 UTC

Requires

MIT c22f016f1d5182309e3d99805906bf77b892af91

This package is auto-updated.

Last update: 2021-02-22 22:38:48 UTC

README

遵循以下定义的规则 Consistence 编码规范，但以下有差异和附加规则。

与 Consistence 编码规范的差异

  • 使用不按顶级命名空间分组（并且通过空行分隔）。
  • 类型，在隐式使用（来自同一命名空间），不使用全限定名称（FQN）扩展/实现。
  • 在注解中允许使用部分使用。
  • 在 @param、@var 和 @return 中使用标量类型的简写形式（例如 bool）。
  • 在所有情况下应遵循 PSR0/4。
    • 对于如 .../exceptions 或 .../data 这样的目录没有例外。
    • 因此，异常应与其他类放置在一起（因为我们不使用命名空间来分隔文件类型）。

附加规则

  • facades/services/finders（通常是基于非值表示的类）中的方法遵循以下命名规则
    • 以 get... 开头的方法永远不会返回 NULL（如果无法返回期望的类型，则应抛出异常）。
    • 以 find... 开头的方法返回期望的类型或 NULL（如果没有找到，不可访问等）。
    • 返回集合/数组的方法的命名形式为 get...，因为它始终返回期望的类型。
    • 返回项目计数的方法的命名也采用 get/find...Count 形式，而不是 count...。