KISS 原则 = 简明扼要 内容全是必须
所有内容都根据自己语言特性和编码习惯挑选
空格与空行
- 区分一行和一条的差别用; 分别
- 区分声明和 执行语句(对数据进行处理) 用空行分开
- 负责各项功能的语句集合,用空行分开
- 不同的控制语句 (if for 之类)用空行区分, 开始部分单独占一行
- 函数与方法之间 用2空行
- 运算符前后各一个空格。逻辑部分用小括号包裹
- 分号前不要空格
- 用 ide 软件开发 最好统一 例如 phpStorm后端的 Visual Studio Code 前端的
- 1行1变量 必须
- 标点符号后 1空格 (, 。 | =>)之类的
括号与缩进
- 函数的大括号独立占行 其余 左边与第一条语句位于同一行
- 缩进 最好 2或4 空格 统一大括号位置
- 代码块必须缩进
- 写完要检查缩进和代码
- 用注释强调重点地方不要
- 嵌套的深度 (if, for) 之类缩进一致 4个最好
简洁+吸引+目标 = 注释
- 注释要有起止点
- 单行注释用于补充说明 或 函数主体没有体现的部分
- 多行注释提供尽可能多的信息
- 任何人都能理解的内容不注释
- 1行1变量 后面或者上面添加注释
- 代码逻辑 严重 部分需要注释到一目了然
- 函数体注释时 ,先说明函数 干什么用的 返回内容用在哪里 方便了解
- 严重区分 == , =, != 别混 最好加注释
- 如果 if for 之类的 语句很长(50行以上) 大括号闭合处 需要加注释
- 函数内部注释 1 目标(主要实现什么内容) 2 数据类型 3返回值用于何处
- 代码本身足以说明的不加注释 不足时要加注释
- 最好检查一边
变量与前缀
- 变量名要包含数据类型 int sting array 取 i s a 之类的 例如 $sName = ‘abc’;
- 函数名称标明 如 getName() setName() del update之类的
- 不要因为变量多就随便起名字 input1 ~ input100
- 不要用相似变量名 如$name $names 你可以写在前面 $xName
- 用驼峰写法大小分明
- 名称尽量短,可以理解
- 没有必要不使用下划线
- 大小写要合理 1 变量名 对象名 首字母小写 2 函数(不确定) 类名 首字母大写 3 常量全部大写
- 不要把 类名和变量名 搞成一样的 如 class a{} $a;这样
- 强调的内 可以用 大写 例如 $setNAME