培养自己的php编码标准

为什么要培养自己的编码标准？

当我们写代码的时候，一个好的编码标准可以给我们带来很多意想不到的效果。至少有一个好处：

1.提高我们的编码效率。统一代码方便我们复制粘贴！2.提高代码的可读性。3.展示我们的特长。别人看到我们的代码，发现整个代码的编写过程是统一的，瞬间就上去了！4.促进团队合作。大家都用同样的规格，从而省去了五花八点的写法，而且同样的协调！

代码包括两个块，代码规范和注释规范。

事实上，我们编写的php脚本实际上是由两大块组成的，即编写代码和对代码进行注释！不同的框架，甚至不同的公司，在这方面都会有不同的意见。在这里，我们只是做了一个陈述，只对自己的写作标准做了一个总结！希望对其他朋友有所启发。

1.代码编写标准。

文件夹名称：

同一文件夹使用小写字母。例如，存储控制器的文件夹可以直接命名为控制器。

文件名：

如果是类文件，文件名要与同类一致，大驼峰统一使用。比如Session.class.php，对应的类名是Session，如果是常用的工具脚本，就统一用一个小驼峰，比如common.php。

类名命名：

使用同名的大驼峰和Cookie类。

方法名称的命名：

统一使用小驼峰，一般用动词排名的形式来描述这种方法的功能，比如sendMessage，发送短消息。在面向对象中，遵循相同的规则，但在某些地方有所不同：

getusername()protected _ gettotalamount()private _ setblanchinum()变量命名约定：

关于变量，我们需要多说几点：1。在面向对象和非面向对象的语法中，变量都使用小驼峰，比如$workYears。然而，它在面向对象方面是不同的。当使用公共属性、受保护属性、私有属性、受保护属性或私有属性时，会添加_作为区别。

public $ start position=1；protected $ _ salaryAmount=1000private $ _ sex=' formale2.如果是常量，统一使用大写，中间用下划线分割。

define('CURRENT_SCRIPT '，' index . PHP ')；const TRANSACTION _ TYPE=' income '；3.对于全局变量，使用大驼峰，前缀为_，所有单词都大写。因为知道一个变量的范围非常重要，局部变量和全局变量要分清楚！

$ _系统_配置；

$ _根_路径；

缩进字符

对于编码缩进符号，我们统一使用制表符缩进！有人可能会问为什么空格缩进不适用。原因很简单。大多数编辑器都支持空格制表符等于多少，但是使用空格就跑调了！

操作符号

的所有二进制运算符前后都应该有空格。

$name='零'；18岁？成人‘:’儿童；通用过程陈述计划。

我们同意流程语句的所有大括号都占据一行。原因：如果遇到复杂的业务逻辑，花括号的嵌套会很多，所以会把对应的花括号都搞混！

1.分支语句。

if($ age=18 $ age=30){ echo ' young man '；}else if($age 30 $age=60){ echo '中年人'；} else { echo ' old man}//下面的代码对我们来说是个问题。在if语句中，即使花括号是不必要的，花括号也要写成if($ age 60){ echo‘我很老了’；} switch($ status){ case ' forbiden ':echo ' log in禁止'；打破；case ' normal ' : echo ' log in '；打破；default: echo“状态错误”:break}2.循环语句。

while($ condition){ States.} foreach($ arrayList as $ arrayKey=$ arrayItem){ States.}do{语句.}while($condition)为($ start条件；changenumber){语句.}2.笔记的写作标准。

很多人说好的代码不需要注释。其实我个人觉得这是一句废话(也许他是对的，除非他是整个团队里唯一的一个，他做什么都不看别人的代码)。

我个人的看法是，多写笔记对团队其他人和我自己都很友好！

根据个人经验，注释至少有以下功能：

1.有利于提高代码的可读性。毕竟，阅读你的评论比阅读你的代码容易得多！2.规划自己的代码布局是有益的！其原因与代码注释的类型有关。“有利于代码的布局”，这似乎有点悬，无法理解。我们需要真实的例子来支持它！3.由于我们的注释规范是按照phpdocumentor的要求，通过这个工具，我们还可以生成代码的通用描述，相当于一个说明书！g

评论的类型。

1.块标注块标注主要用在三个地方。php脚本的描述、大型功能模块的描述以及不能在一行内完成的注释也应该放在块注释中。

2.行注释行注释。我个人觉得他是用block评论工作的！一般用来描述一个大功能模块的具体细节！

实际案例。

至于phpdocumentor语法的具体用法细节，我在这里就不多说了，但是在官网上就不能说得更清楚了。

从上面的例子中，我们可以看到代码的总体布局，但是我们仍然需要在实践中慢慢探索。

下面附上一些php编程规范供大家参考。

一、文件标记：

1.所有的php文件都标有完整的php标签，不建议使用短标签(短标签很容易和xml混淆，从5.4开始php默认不支持短标签)。

2.对于纯php代码文件，建议省略“？”。这是为了防止额外的空格或其他字符影响代码。

二是文件和目录命名。

1.程序文件名和目录名都用有意义的英文命名，没有拼音和无意义的字母。仅允许字母、数字、下划线和下划线字符。同时，它们必须以'结尾。PHP '(模板文件除外)。多词之间采用驼峰命名法。

示例：//统一采用：DemoTest.class.php。

//统一接口：DemoTest.interface.php。

//其他人遵循自己的方法：降级。{style}.php。

第三，文件目录结构。

标准化的目录结构有助于团队协同开发和后期维护。

3354 app//独立应用。

3354类//单一类文件，共享类文件。

—— config/Inc///配置文件或目录。

3354数据//数据文件或目录。

3354文档//程序相关文档。

——htdocs //document_root

3354图片//所有图片文件的存储路径。

——css //css文件。

——js //js文件。

3354 lib//共享类库。

3354模板//模板文件。

3354tmp//的临时文件目录。

3354缓存//缓存文件。

——session //SESSION文件。

3354 template _ c//编译后的模板文件。

——其他

3354上传//上传文件。

3354 manage//后台管理文件目录。

四.命名规范。

1.变量命名：php中的变量区分大小写。有效的变量名以数字、字母或下划线开头，后跟任意数量的字母、数字和下划线。

a)整个程序采用驼峰命名，以小写字母开头，同时命名要有意义。(函数displayName())

B)PHP全局变量键值两边有' _ '，中间用驼峰命名法命名。($_GLOBAL['_beginTime_'])

c)普通变量整体采用驼峰命名，建议变量前加类型前缀。不确定类型以大写字符开头。

d)函数名应尽可能有意义和缩写。

2.类和接口的命名：

a)以大写字母开头。

b)由多个单词组成的变量名，单词之间没有空格，每个单词的首字母大写。

c)类名与类文件名一致。

d)程序中的所有类名都是唯一的。

e)抽象类应该从抽象开始。

接口命名规则：

I)采用与类相同的命名规则，但在其命名前添加“I”字符以指示接口。

Ii)尽量保持类名与其实现的类名一致。

3.数据库命名：在数据库的命名中，不出现大写。

a)所有表名都使用小写字母。

b)表名使用相同的前缀，前缀不能为空。

c)对于由多个单词组成的表名，使用“_”间隔。

d)表字段的命名规则。

I)使用所有小写字母。

Ii)多个单词不加下划线。

Iii)用表名的第一个字母作为公共字段的前缀。

Iv)避免使用关键词和保留词。

动词（verb的缩写）注释规范

1.程序说明：写在代码前面而不是后面，单行代码根据习惯写在代码末尾；大注释采用/* */的形式，通常在文件或函数的顶部，代码内部使用“//”；评论不要太多；注释应该描述为什么，而不是什么，并向代码读者提供最重要的信息。

2.文档注释：文档注释通常放在文档的顶部，包括描述、作者、项目名称、文件名、时间和日期、版本信息以及重要的使用说明(类调用、注意事项等)。).更改要修改的版本号，并添加mofify注释。

3.关于类和接口的注释：按照一般的习惯，一个文件只包含一个类。

4.方法和函数的注释：方法和函数的注释写在前面，通常需要注明信息的主要可见性、参数类型和返回值类型。

/**

*连接到数据库。

* @param string $dbhost数据库服务器地址。

* @param string $dbuser数据库用户名。

* @param string $dbpwd数据库密码。

*/

不及物动词代码样式

1.缩进和空格：用4个空格代替制表符作为缩进；分配变量时，等号两边留有空格。($ URL=' $ _ GET[' URL ']'；)

2.断句：尽量保证程序语句的一行是一句话；尽量不要让一行代码太长，在80个字符以内；如果线路代码太长，请以类似于'的方式断开线路。=';执行数据库的sql语句操作时，尽量不要在函数中编写sql语句，而是先用变量定义sql语句，然后调用操作函数中定义的变量。

3.更好的习惯：在代码中使用下面列出的方法可以使代码更加优雅。

1):使用更多php中已经存在的常量，而不是自己定义。

示例：//wrap。

echo $msg。\ r \ n '；

echo $msg，PHP _ EOL

Php _ eol是一个预定义的常量，表示一行的结束。有了不同的系统，PHP_EOL更加便携。

2):在echo中使用逗号作为连接符比使用“.”更美观作为连接器代码。

3):单引号比双引号更有效率，但用法不同。学习使用printf函数。

示例：//echo

呼应“每个”。$ scholl。大约有。下限(平均值)。学生；

//printf

$format='每个%s有超过$d个学生'；

printf($format，$school，$ avg)；

4):详细评论。

5):不要滥用语法糖，这是语言中的一个潜规则，即没有普遍表征的语法。