PHP PSR-1 Basic Coding Standard

PSR-1 对基础的编码进行的规范.

• 规范总览

1. PHP 源文件只使用 <?php 和 <?= 这2种标签.
2. PHP 源文件保存是编码格式为: 不带字节顺序标记(BOM)的UTF-8编码.
3. PHP 源文件建议保持功能单一, 对定义 classes, functions, constants 等代码为单独的源文件, 对操作等代码比如 输出信息, 修改ini 配置等也独立成源文件, 不建议单个源文件中同时包含上面2部分的操作.
4. 命名空间需要符合 PSR-0 和 PSR-4 标准.
5. 类名使用 StudlyCaps 进行命名. StudlyCaps 是 驼峰式(camelCase)的一种变种.
6. 类中的常量名使用全部大写字母和下划线组成.
7. 函数方法使用驼峰式camelCase命名法.

• 规范解释

  • 对于规范1, 规范2 起始没什么好说的. 这个是个共识. 不要刻意破坏.

  • 对于规则3, 关于代码的组织方式问题. 这个需要看个人的经验. 有经验的工程师会把代码组织的井井有条. 初学者则的混乱堆叠在一起. 改规则只是一个大体的指明了方向. 代码的结构还需要根据具体的功能, 业务等进行合理的布局.

  • 规则4涉及到命名空间问题特别要注意去理解 PSR-4, 这个涉及到 composer 代码管理包和 autoload. 这个非常非常重要.

  • 规则5的类名命名, 这里类名使用 StudlyCaps风格, 简单的可以理解为 大驼峰式 命名法.

  • 规则6已经在各个开源项目中大家都遵循的标准. 一目了然.

  • 规则7推荐在函数命名的时候遵循标准. 这里使用 小驼峰式 命名法.