PHP编码规范

编程规范在团体开发中能使程序员按照统一标准编程,消除了混乱和迷茫,能使他们将精力聚焦于更重要的事情,而不是变量如何命名这些琐事上。个人编程也需要一份规范。“在通往牛逼的道路上,让一部分事情先做起来”。据此,我指定了自己的编程规范,虽不完善,但先安这份规范编程。

确定下来的

书上说编码规范很重要,我早就觉得有必要弄一份自己的编码规范出来。可我把这件事情看得很难,好像一定要完全有把握才能定一份编码规范。而且,一做就要做一份十全十美的编码规范。结果是迟迟未能有一份编码规范。

先不管了,就像某个公众号上说的那样,“在通往牛逼的道路上,先把一部分事情做起来”。实际上,在平时写代码时,我虽然没有固定的编码规范,但却有一些不成文的习惯在约束着我。这些习惯中还有一些悬而未决的问题。索性,将这些习惯写出来,先按照这份规范编程,在实践中再完善。

  1. 文件名,使用驼峰法则,首字母小写。
  2. 变量名、类属性,使用驼峰法则,首字母小写。
  3. 函数名、类方法名,使用驼峰法则,首字母小写。使用“动词 + 名词”结构。
  4. 类名,使用驼峰法则,首字母大写。
  5. 常量,使用大写字母,下划线分割不同单词。
  6. 不使用硬编码,用常量或类属性等代替。
  7. 行缩进使用一个tab键。
  8. 大括号另起一行。
  9. 小括号不另起一行。
  10. 文件头部注明文件功能、作者;函数或类方法注明功能,必要时补充其他注释。
  11. 更新数据的函数或方法用update开头。
  12. 新增数据的函数或方法用insert开头。
  13. 删除数据的函数或方法用delete开头。
  14. 接口返回数据如下:

{
'code': 1000,
'sucess': true,
'message': '操作成功'
}

待确定的

  1. 类A的文件名应该是A.class.php还是A.php?
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 整理自 PHP 标准规范 作为程序员来说,采用统一的编码风格是非常重要的。这将给未来代码的编写、阅读节省大量时间。...
    野尘lxw阅读 3,950评论 0 2
  • 很多时候,我们可以看到国外的框架有有很多特别的写法,但是我们却不明其为什么要这么写,其实他们都是规范于PSR标准。...
    益初阅读 4,196评论 0 2
  • 源文来自https://github.com/TIGERB/easy-tips,分享给大家 共同进步 编码规范 P...
    回眸淡然笑阅读 3,421评论 0 0
  • PSR:PHP编码规范(Proposing a Standards Recommendation) 只贴出一些需要...
    esrever阅读 3,025评论 0 1
  • 1.什么是RDS数据库? RDS数据库是在一个实例下创建的逻辑单元,一个实例可以创建多个数据库,在实例内数据库命名...
    Separes阅读 7,142评论 0 2