PHP代码、文件命名规范

命名规范

开发的过程中应该尽量遵循下列命名规范:

  • 类文件都是以.class.php为后缀(这里是指的ThinkPHP内部使用的类库文件,不代表外部加载的类库文件),使用驼峰法命名,并且首字母大写,例如 DbMysql.class.php
  • 类的命名空间地址和所在的路径地址一致,例如 Home\Controller\UserController类所在的路径应该是 Application/Home/Controller/UserController.class.php
  • 确保文件的命名和调用大小写一致,是由于在类Unix系统上面,对大小写是敏感的(而ThinkPHP在调试模式下面,即使在Windows平台也会严格检查大小写);
  • 类名和文件名一致(包括上面说的大小写一致),例如 UserController类的文件命名是UserController.class.php, InfoModel类的文件名是InfoModel.class.php, 并且不同的类库的类命名有一定的规范;
  • 函数、配置文件等其他类库文件之外的一般是以.php为后缀(第三方引入的不做要求);
  • 函数的命名使用小写字母和下划线的方式,例如 get_client_ip
  • 方法的命名使用驼峰法,并且首字母小写或者使用下划线“_”,例如 getUserName_parseType,通常下划线开头的方法属于私有方法;
  • 属性的命名使用驼峰法,并且首字母小写或者使用下划线“_”,例如 tableName_instance,通常下划线开头的属性属于私有属性;
  • 以双下划线“__”打头的函数或方法作为魔法方法,例如 __call 和 __autoload
  • 常量以大写字母和下划线命名,例如 HAS_ONE和 MANY_TO_MANY
  • 配置参数以大写字母和下划线命名,例如HTML_CACHE_ON
  • 语言变量以大写字母和下划线命名,例如MY_LANG,以下划线打头的语言变量通常用于系统语言变量,例如 _CLASS_NOT_EXIST_
  • 对变量的命名没有强制的规范,可以根据团队规范来进行;
  • ThinkPHP的模板文件默认是以.html 为后缀(可以通过配置修改);
  • 数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如 think_user 表和 user_name字段是正确写法,类似 _username 这样的数据表字段可能会被过滤。

流程语句规范

所有流程语句的花括号都单独占据一行。理由:如果遇到较为复杂的业务逻辑,花括号会出现很多的嵌套,这样一来我们会混淆个个对应的花括号!

1、分支语句


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

if($age >= 18 && $age <= 30)

{

  echo ‘young man‘;

}

else if($age > 30 && $age <= 60)

{

  echo ‘middle aged‘;

}

else

{

  echo ‘old man‘;

}

//下面这段代码高手我们一个问题,在if语句中,即使在可以不要花括号的情况下,花括号也是要写上的

if($age > 60)

{

  echo ‘I am very old‘;

}

switch($status)

{

  case ‘forbiden‘

    echo ‘login forbidden‘;

    break;

    

  case ‘normal‘:

    echo ‘login in‘;

    break;

    

  default:

    echo ‘status is wrong‘

    break;

}

2、循环语句


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

while($condition)

{

  statesments......;

}

foreach($arrayList as $arrayKey => $arrayItem)

{

  states......;

}

do

{

  statements......; 

}

while($condition)

for($start; condition; changenumber)

{

  statements......;

}

总体需遵规则

开发的过程中,遵循以下规则,会让你的开发变得更轻松:

  • 遵循框架的命名规范和目录规范;
  • 开发过程中尽量开启调试模式,及早发现问题;
  • 养成使用I函数获取输入变量的好习惯;
  • 更新或者环境改变后遇到问题首要问题是清空Runtime目录;
时间: 2024-11-09 00:21:13

PHP代码、文件命名规范的相关文章

代码编写与文件命名规范

文件命名规范 所有文件名均使用*小写字母*.文件名中不能包含_.所有类的文件名以.class.php结尾.类名和文件名的对应关系是 目录_目录_文件名 的形式. 例如Model_MySQLi_Abstract对应的就是model/mysqli/abstract.class.. 缩进规则与行书写规范 所有代码中,均使用4个空格作为缩进标准,不允许使用制表符(tab). 这样做的好处是:不管什么系统或者编辑器下看,代码都是整齐的.在使用SVN.CVS等工具或者查看diff时,不会对编码和阅读人员带来

Android转载一:Android文件命名规范

REF:http://blog.csdn.net/gulianchao/article/details/23391651 (一) Layout命名1.contentview命名:activity_功能模块.xml例如:activity_main.xml.activity_more.xml2.Dialog命名:dialog_描述.xml 例如:dlg_hint.xml2.PopupWindow命名:ppw_描述.xml 例如:ppw _info.xml 列表项命名listitem_描述.xml 例

IOS中Objective-C代码及命名规范

想做一名ios开发工程师,代码命名不规范是一种不专业的表现,因为ios开发工程师们学出来的代码会给很多人看,为了使代码清晰简洁,方便阅读理解,都会统一遵从一定的代码规范,Objective-C同样如此. 简单总结一下目前接触到的: 1.代码行度最大为100列(C++的是80) 2.声明类或方法时,注意空格的使用,参数过多时可换行保持对齐,调用方法时也是如此,参数都写在一行或换行冒号对齐. 3.命名规则 类名首字母大写,方法首字母小写,方法中的参数首字母小写,同时尽量让方法的命名读起来像一句话,能

Android资源文件命名规范学习手册

[推荐] 资源文件需带模块前缀.[推荐] layout 文件的命名方式. Activity 的 layout 以 module_activity 开头 Fragment 的 layout 以 module_fragment 开头 Dialog 的 layout 以 module_dialog 开头 include 的 layout 以 module_include 开头 ListView 的行 layout 以 module_list_item 开头 RecyclerView 的 item la

【转】APP界面切图命名和文件整理规范

转自:http://www.chinaz.com/design/2015/0908/443732.shtml 规范的命名方式可以提高客户端程序员的开发效率和团队协作.个人觉得标识符命名原则:尽可能的用最少的字符而又能完整的表达标识符的含义. 切图命名英文缩写三个原则: 1 较短的单词可通过去掉"元音"形成缩写 2 较长的单词可取单词的头几个字母形成缩写 3 此外还有一些约定成俗的英文单词缩写. 第一部分:iOS  APP界面设计切图命名规范 以上切图命名规范信息图来源:http://w

第四章 android 命名规范和编码规范

书里面讲的比较常见,单个人也是有不同的观点: 因为android绝大部分使用java开发的,因此java相关规范适用于android: Google Style: 英文地址:http://google-styleguide.googlecode.com/svn/trunk/javaguide.html 中文翻译:http://www.blogjava.net/zh-weir/archive/2014/02/08/409608.html 然后说下我在android开发中的命名规范和编码规范: 先分

CSS命名规范参考及书写注意事项

CSS书写顺序 *{ /*显示属性*/ display position float clear cursor - /*盒模型*/ margin padding width height /*排版*/ vertical-align white-space text-decoration text-align - /*文字*/ color font content /*边框背景 为什么要把 boder和background放在最后的原因是修改的频率会较之前的频繁,放在最后查看起来方便,哈哈.*/ 

要想成为前端大神,那些你不得不知晓的web前端命名规范。

一.Web语义化 1.1 H5的语义化 对于经验资深的前端er,在给web布局时,相信都会很注重标签和命名的规范.尤其是随着html5的普及发展,更是把web前端语义化推向一个新的台阶上.比如html5给我们新增的语义标签:header.nav.main.aside.footer.section.article等等.那么对于web语义化,有什么优势呢? 1.2 语义化优势 可以让人一目了然代码结构块,对于项目的维护或者优化都是非常有意义的. 语义化能提高页面SEO.如:<header><

plsql 书写命名规范

俗话说事不预则废,无规矩不成方圆. 对sql脚本程序的设计,个人认为应该是从编码规范开始. 前段时间公司一些同事提交的脚本,风格迥异,让我审核起来倍感难受,丝毫没有审核代码的快感. 特整理了公司部分常规的编码规范,对新人进行了培训,希望同志们写的代码更美观和高效(注:规范部分收集于网络,感谢网络大虾们的贡献): 1.1. PL/SQL 程序命名规范 1.              无论是 PL/SQL 对象还是 PL/SQL 对象内部用的变量和游标等,都必须能从名称上能让人理解变量和游标的含义,