php团队规范,简单的PHP团队编程规范与习惯
简单的PHP团队编程规范与习惯
2年前
阅读 3259
评论 0
喜欢 1
####1、PHP 编程规范与编码习惯最主要的有以下几点:
1、文件说明
2、Function 函数体说明
3、代码缩进
4、IF省略
5、变量规范
6、命名规范
7、十行一注释
8、注释风格
9、开放关闭原则
####2、文件说明 我的个人代码 - 规范如下:
```php
/*
+----------------------------------------------------------------------
+ Title : 标题
+ Author : 作者
+ Version : 版本号
+ Initial-Time : 这个文件初始创建的时间
+ Last-time : 这个文件最后修改的时间 + 修改人的名称
+ Desc : 这个文件的简单描述
+----------------------------------------------------------------------
*/
```
####3、function 函数体说明:
```php
/**
* 函数体简单的描述
* @author_start : 作者
* @author_end : 修改时间 + 修改者
* @param string : $id 描述
* @param array : $array 描述
* @param array : $num 描述
* @return : 返回值说明
*/
function Test($id, $array = array(), $num = 1){
}
```
注意:function里面变量参数的代码缩进风格
####4、代码缩进:
```php
$str = 1;
$info = '123';
$version = '123123';
$name = 'test';
$i = 'haha';
# 一般在最外部的if 或流程控制语句都应该上下留空一行
if ($info) {
}
# 一般在最外部的for或者 foreach都应该上下留空一行
for ($i=0 ,$i<6 ,$i++){
}
```
####5、if省略
```php
# 一般在if语句与其分支的流程控制语句当中,存在这exit或者return的情况下,都应该省略其else的部分操作
# 错误
if () {
return false;
} else {
return true;
}
# 正确
if () {
return false;
}
return true;
```
####6、变量规范,使用英文命名
```php
# 正确
$title = '标题';
$name = '名称';
$pwd = '密码';
# 错误
$biaoti = '标题';
$ming = '名称';
$mima = '密码';
```
####7、命名规范
```php
/**
* 实际开发中,命名方式一般有三种情况
* 注意:不管是类名,变量,方法名,在实际开发中,最多只能是不超过3个单词的组合
* 大驼峰 :每个单词首字母大写
* 小驼峰 :中间单词首字母大写
* 蛇形 :每个单词小写,单词与单词之间使用 _ 符合链接
*/
# 大驼峰,常用于类名定义
class Car{}
class BlueCar{}
# 小驼峰,常用于方法名定义
class Car{
public function getColor(){}
}
# 蛇形,常用于变量名定义
$res_id = 1;
$res_name = 2;
```
####8、注释风格
```php
1、当需要对某段代码,做大量描述时,使用以下注释风格
/**
* 我是说明
* ① 流程一
* ② 流程二
* ③ 流程三
*/
2、当需要对一行代码,做小量描述时,使用以下注释风格
# 这是XXXX给ZZZZ的变量,叫CCCC
$name = '';
3、当需要对一行代码,做简介描述时,使用以下注释风格
$name = ''; // X表的字段
$index_head = ''; // 首页请求头
```
####9、开放关闭原则
实际上这是一个概念,是设计模式中的一种。
简单来说,就是一个已经完成上线的class或者api,可以在不改动起原文件的情况下,对其功能进行外部扩展。
当然,这一点不是一个初级程序员能够做到的事情,有兴趣的朋友可以看下博客里的设计模式,对逻辑思维的提升,在初期会有不少的帮助。
© 著作权归作者所有
php团队规范,简单的PHP团队编程规范与习惯相关推荐
- 简单叙述python的编程规范_简明 Python 编程规范
注:之前发布一篇<简明 Python 编程规范>(见:http://blog.csdn.net/lanphaday/article/details/2834883),本是我给当时所在的公司 ...
- 简述python程序的书写规范_简明的 Python 编程规范
简明的 Python 编程规范 使用编码规范编写程序,不仅可以别人让后面维护的人更方便,同时也方便自己检查程序.以下是百分网小编精心为大家整理的简明的 Python 编程规范,希望对大家编写程序有所帮 ...
- 华为python语言通用编程规范 模块导入顺序_Python编程规范
1,Python编程规范 > 编码 所有的 Python 脚本文件都应在文件头标上 #-*- coding:utf-8 -*- 用于设置编辑器,默认保存为 utf-8 格式. > 注释 业 ...
- 定义变量和常量的规范 c语言,C语言编程规范教材及练习(标识符命名与定义 变量 宏、常量 表的达式).pptx...
C语言编程规范教材及练习(标识符命名与定义 变量 宏.常量 表的达式) C语言编程规范教材C语言编程规范工作组 201104目录标识符命名与定义 变量宏.常量表达式标识符的命名要清晰原则3.1 标识符 ...
- Shell编程规范与变量(shell编程规范,执行脚本文件的四种方式,管道符号与重定向,shell变量的作用于类型)
文章目录 Shell脚本概述 Shell脚本的概念 Shell的作用 Shell编程规范 重定向与管道 Shell脚本变量 自定义变量 特殊变量 Shell脚本概述 Shell Script ,She ...
- c语言程序的基本规范是什么,C语言编程规范——3 命名规则
3 命名规则 3.1 命名的基本原则 标识符的命名要清晰.明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解--尽量采用采用英文单词或全部中文全拼表示 3.2变量名的命名规 ...
- python使用符号#表示单行注释-【经济金融及Python应用讲义】Python编程规范之注释...
原标题:[经济金融及Python应用讲义]Python编程规范之注释 来源:计量经济学服务中心 经济金融及Python应用讲义 一.注释 1.为什么需要注释 如果代码的编写者在这里添加了备注说明,那么 ...
- python使用符号 表示单行注释-Python编程规范之注释
来源:计量经济学服务中心 经济金融及Python应用讲义 一.注释 1.为什么需要注释 如果代码的编写者在这里添加了备注说明,那么读者很快就能理解该段代码的含义了. 可以发现,在编写代码的过程中,我们 ...
- python代码注释规范-Python编程规范之注释
来源:计量经济学服务中心 经济金融及Python应用讲义 一.注释 1.为什么需要注释 如果代码的编写者在这里添加了备注说明,那么读者很快就能理解该段代码的含义了. 可以发现,在编写代码的过程中,我们 ...
最新文章
- C#多线程学习(二) 如何操纵一个线程
- Acwing第 2 场周赛【完结】
- redhat php5 安装,完整的linux(RedHat)+php5.3.10+mysql5.5.19+apache2.2.22安装配置说明
- mysql免安装版配置方法
- windows bat 设置ip_A6v5.1网络版安装与防火墙设置
- Android studio编译好的apk文件在哪里?
- .NET的资源并不限于.resx文件,你可以采用任意存储形式[上篇] (转载)
- 软件工程网络15个人作业3——案例分析
- TI AM335x Linux MUX hacking
- Syncthing:开源 P2P 文件同步工具
- EasyGUI 学习文档
- X509证书结构及解析
- 基于spss的相关性分析(correlation analysis)
- 【51单片机】 利用定时器产生生日快乐歌
- Java学习笔记【10】常用类 - - Math类、Random类及随机数详解
- [CF1603D] Artistic Partition——欧拉函数,线段树优化DP
- PHP - preg_split详解
- 量化评价和质化评价举例_课程评价中的量化评价与质性评价
- InternalEror :Dst tensor is not initialized
- Linux下的cmt2300a驱动
热门文章
- Windows 之 win10快捷键
- [转贴] C++内存管理检测工具 Valgrind
- perl的Getopt::Long和pod::usage
- 解决set /p yn= 接受键盘输入导致ECHO 处于关闭状态的问题
- mybatis 调用 oracle 存储过程 select into 无记录时NO_DATA_FOUND异常处理分析
- VNX证书过期解决方案(2018-11-02)
- uniapp、vue,vuex中state改变,getters不动态改变的完美解决方案!
- json.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0) 问题解决
- [持续更新]UnsatisfiedLinkError常见问题及解决方案
- Java中的异常和处理详解