腾讯文档php技巧_百度T7的PHP大年夜神亲自体验为什么要培养编码规范

文章目录 [+]

我们写代码的时候，一个好的编码规范，对我们来说能够起到很多意向不到的效果。
至少会有一下的好处：

1、提高我们的编码效率。
整洁划一的代码方便我们进行复制粘贴嘛！

腾讯文档php技巧_百度T7的PHP大年夜神亲自体验为什么要培养编码规范

编码规范包含两大块，代码规范和注释规范

（图片来自网络侵删）

实在我们所写的php脚本，实在也便是由两大块组成的，即对代码的书写、对代码的注释！
不同的框架，乃至不同的公司，对这方面都会有所不同，这里只是已将之言，仅仅是对自己的书写规范进行一个总结！
希望能对其他的朋友以启迪

1、代码的书写规范

文件夹的命名：

文件夹同一利用小写字母。
如存放掌握器的文件夹，直接命名为controller即可

文件的命名：

如果是类文件的话，那么文件的命名该当同类名称保持同等，统一利用大驼峰。
如Session.class.php , 对应类名称为Session，如果是普通的工具脚本，那么统一利用小驼峰，如common.php

类名称的命名：

类名称同一利用大驼峰，Cookie类

方法名的命名：

统一利用小驼峰，一样平常利用动词 + 名次的形式来描述该方法的功能，如sendMessage,发送短信。
在面向工具中，遵照同样的规则，但是个别地方有所差异：

publicgetUserName()protected_getTotalAmount()private_setBlanceAmount()

变量的命名规范：

关于变量，我们须要多说几点：1、无论在面向工具还是非面向工具的语法中，变量统一利用小驼峰，如：$workYears。
但是在面向工具中又有所不同，public 、 protected 、 private ,protected或者private属性的时候，前面加上了 _ 作为差异

public$startPosition=1;protected$_salaryAmount=1000;private$_sex='formale';

2、如果是常量的话，统一利用大写，中间利用下划线进行分割。

define('CURRENT_SCRIPT','index.php');constTRANSACTION_TYPE='income';

3、全局变量，利用大驼峰，前缀加上 _ ,所有的单词首字母大写。
由于知道一个变量的浸染域是非常主要的，以是局部变量和全局变量该当很明显的进行分开！

$_System_Config;

$_Root_Path;

缩进符

关于编码的缩进符号，我们统一利用制表符缩进！
大概有的人会问为什么不适用空格缩进的呢？缘故原由很大略，大部分的编辑器都支持制表符即是多少个空格，而利用空格就没得调了！

运算符号

所有的两元运算符号，都该当前后利用空格进行

$name='zero';$age>18?'adult':'children';

常见的流程语句方案

我们约定，所有的流程语句的花括号都单独霸占一行。
情由：如果碰着较为繁芜的业务逻辑，花括号会涌现很多的嵌套，这样一来我们会稠浊个个对应的花括号！

1、分支语句

if($age>=18&&$age<=30){echo'youngman';}elseif($age>30&&$age<=60){echo'middleaged';}else{echo'oldman';}//下面这段代码高手我们一个问题，在if语句中，纵然在可以不要花括号的情形下，花括号也是要写上的if($age>60){echo'Iamveryold';}switch($status){case'forbiden'：echo'loginforbidden';break;case'normal':echo'loginin';break;default:echo'statusiswrong'：break;}

2、循环语句

while($condition){statesments......;}foreach($arrayListas$arrayKey=>$arrayItem){states......;}do{statements......;}while($condition)for($start;condition;changenumber){statements......;}

2、注释的书写规范

很多人说好的代码是不须要注释的，实在，个人认为这是一句很扯淡的话（也可能他是对的，除非全体团队就他一个人，他包办了统统，不用看别人的代码）。

个人的不雅观点是：多写注释，无论是对团队的其他人，还是对自己都是非常友好的！

根据个人的履历来看，注释至少有以下几个浸染：

1、有利于提高代码的可读性，毕竟读你的注释要比读你的代码要随意马虎的多！
2、有利于方案自己的代码布局！
之以是这么说，是由于和代码注释的种类有关。
“有利于代码的布局”，这种看着有点悬的事，光说是说不明白的，我们须要实实在在的例子做支撑！
3、由于我们的注释规范是按照phpdocumentor的哀求，以是通过这个工具，还可以天生一份对代码的总体解释，相称于一个利用解释书！

代码注释的种类

1、块注释块注释，个人认为紧张用在了三个地方。
对php脚本的描述、对一个大的功能模块的描述、在一行之内不能写完注释的时候，也该当放在块注释中

2、行注释行注释，个人认为他是合营块注释进行事情的！
一样平常用于描述一个大的功能模块的详细细节！

下面附上一些php的编程规范，给大家参考下

一、文件标记：

1.所有php文件，其代码标记均采取完全php标签，不建议利用短标签（短标签随意马虎和xml稠浊，php从5.4开始默认不支持短标记）。

2.对付只有php的代码文件，建议省略结尾处的‘?>'。
这是为了防止多余的空格或其他字符影响到代码。

二、文件和目录命名

1.程序文件名和目录名均采取故意义的英文命名，不该用拼音和无意义的字母，只许可涌现字母、数字、下划线和中划线字符，同时必须以‘.php'结尾（模板文件除外），多个词间利用驼峰命名法。

例：//类统一采取：DemoTest.class.php//接口统一采取：DemoTest.interface.php//其他按照各自的办法：demoTest.{style}.php

三、文件目录构造

规范的目录构造有助于团队协作开拓和后期掩护。

——app//独立的运用——class//单个的类文件，共用的类文件——conf/inc//配置文件或目录——data//数据文件或目录——doc//程序干系文档——htdocs//document_root——images//所有图片文件存放路径——css//css文件——js//js文件——lib//共用类库——template//模板文件——tmp//临时文件目录——cache//缓存文件——session//SESSION文件——template_c//编译后的模板文件——other——upload//上传文件——manage//后台管理文件目录

四、命名规范

1.变量命名：php中变量区分大小写，一个有效的变量名由数字、字母或下划线开头，后面追随意任性数量的字母、数字、下划线。

a）程序整体以驼峰命名法，以小写字母开始，同时命名要故意义。
（function displayName()）

b）PHP全局变量键值两边都有‘_'，中间用驼峰命名法命名。
（$_GLOBAL['_beginTime_']）

c）普通变量整体采取驼峰命名法，建议在变量前加表示类型的前缀。
不愿定类型的以大写字符开头。

d）函数名要只管即便故意义，只管即便缩写。

2.类及接口命名：

a）以大写字母开头。

b）多个单词组成的变量名，单词之间不用间隔，各个单词首字母大写。

c）类名与类文件名保持同等。

d）程序中所有的类名唯一。

e）抽象类应以Abstract开头。