代码规范

参考文献

《腾讯c++代码规范》(虽然没用到c++但是空行规则有参考到)
引用自CSDN:腾讯PHP开发规范v1.0
引用自CSDN 前端代码规范(参考腾讯前端规范)
菜鸟教程html5代码规范

缩进

php及js

缩进
每个缩进的单位约定是4个空格的缩进,并且不可使用制表符作为缩进

前端html

根据结构有层次的缩进

变量命名

php

命名规范
命名只能由小写字母或大写字母和数字构成,并且只能是以小写字母打头 遵循驼峰命名法

前端

采用小驼峰命名法
命名规范:如果没有具体的类型,就可以使前缀为名词

每行最多字符数

1)行长度不可有硬限制。
2)行实际长度不应超过80个字符;较长的行应当被拆分成多个不超过80个字符的后续行。
3)一行不应多于一个语句。

函数最大行

不超过120行

函数、类命名

php


1)类必须单独一个源文件,并且类名和文件名相同。
2)类的左花括号必须放到下一行,右花括号必须放在类主体的下一行。
3)类文件“?>”结束标记去掉
4)命名规范
命名只能由小写字母或大写字母和数字构成,并且只能是以小写字母打头 遵循驼峰命名法

前端

命名方式:采用小驼峰命名方式(构造函数采用大驼峰命名)
命名规则:前缀为为动词

动词 含义 返回值
can 判断是否可以执行某个动作(权限) 函数返回一个布尔值,true为可执行
has 判断是否含有某个值 函数返回一个布尔值
is 判断是否为某个值 函数返回一个布尔值
get 判断是否为某个值 函数返回一个非布尔值
set 设置某个值 无返回值

function canRead(){ return true; } //获取姓名 function getName(){ return this.name; }

常量

php

常量名
常量全部使用大写字母和下滑线组成,常量的名称中不允许出现小写字母,可使用分隔符作为下划线。

前端

命名方法:全部大写
命名规范:使用大写字母与下划线来组合命名,下划线用来分割单词

var MAX_COUNT = 10;
var URL = 'http://www.baidu.com';

空行规则

空行可以用来改善可读性和区分相关的代码块。

  1. 相对独立的程序块之间要使用空行分开;
  2. 变量声明应尽可能靠近第一次使用处,避免一次性声明一组没有马上使用的变量。
  3. 函数间要使用空行分开;
  4. 每个类声明之后应该加入空格同
    其他代码分开

注释规则

注释
1)单行注释:在语句结尾用双反斜杠”// “注释
2)多行注释:多行注视以”/”或“/* ”符号开头,以”/ “符号作为注释结束符。

// 单独在一行
setTitle(); // 在代码后面
// setTitile();
/*
* 我是多行注释
*/

html的注释:

<!--注释内容-->

操作符前后空格

php

每个运算符与两边参与运算的值或表达式中间要有一个空格

html

操作符前后不写空格

其他规则

1 应用目录结构

images/ 包含图片文件
config/ 包含配置文件
controllers/ 包含控制器的类文件
views/ 包含控制器的视图和布局文件

2 PHP编码规范

  1. 标签
    PHP程序可以使用或来界定 PHP 代码,在HTML页面中嵌入纯变量时,可以使用这样的形式,不可使用其他的标签变种。
    纯PHP类文件,文件最后一个?>省略。
  2. 编码
    PHP代码必须只使用不带BOM的UTF-8。
  3. 文件
    1)所有的PHP文件必须使用Unix LF(换行)作为行结束符。
    2)所有PHP文件必须以一个空行结束。
    3)纯PHP代码的文件关闭标签?>必须省略
  4. 控制结构
    对于控制结构的样式规则概括如下:
    1)控制结构关键词之后必须有一个空格
    2)左括号之后不可有空格
    3)右括号之前不可有空格
    4)在右括号和左花括号之间必须有一个空格
    5)代码主体必须有一次缩进
    6)右花括号必须主体的下一行
  5. if,elseif, else
    一个if结构看起来应该像下面这样。注意括号,空格,花括号的位置;并且else和elseif在前一个主体的右花括号的下一行。
<?php
	if()
	{
		body
	} 
	else 
	{

	}
?>

3 HTML

  1. 不可以混合大小写,元素名、属性名等等全都使用小写字母。
  2. 必须关闭所有HTML元素

相关文章: