命名规范与编码规范.pdfVIP

命名规范与编码规范 1. ⽬录规范 Addons 插件⽬录 （每个⼦⽬录代表⼀个插件） Application 应⽤模块⽬录 Admin 后台模块 Common 公共模块，不能通过URL访问 Home 前台模块 User ⽤户中⼼ 户端，不能通过URL访问 Public 公共资源⽬录 Uploads 公共上传根⽬录 2.编码规范 功能没有完成的时候⼀定要写 (TODO:) ⽅法和函数有注释，注释内容包括功⽤，参数，返回值，作者，必要是还有⽰例 逻辑复杂的代码，关键部分应有注释 2.1 PHP编码规范 类⽂件命名 - 同Thin PHP命名规范 公共控制器的名称应该和模块名称相同 默认控制器层 Controller ⽅法命名规范 - 驼峰命名，不能出现下划线 类属性规范 - 类属性和类⽅法⼀致,统⼀使⽤驼峰 函数命名 - ⼩写字母加下划线 变量命名规范 - 产品中不涉及到全局变量,局部变量不做强制要求,建议使⽤下划线 后台控制器⾥给列表赋值的变量都⽤list , 单⼀数据读取、保存都⽤data,其他临时变量 最好不要使⽤这两个，以免造成冲突 2.2 前端编码规范 2.2.1 模板⽂件相关常量 PUBLIC 公共资源⽂件⽬录 STATIC 公共静态⽂件⽬录 ADDONS 当前模块插件在STATIC/插件名同名资源⽬录 IMG 当前模块图⽚⽬录 CSS 当前模块CSS ⽬录 JS 当前模块JS ⽬录 2.2.2 模板⽂件规范 所有的模板⽂件都继承 Public/base⽂件，base模板提供了以下可重载的块 style ⽤于添加页⾯样式⽂件 script ⽤于添加页⾯JS⽂件和JS代码 sidebar 左边导航区域 body 页⾯内容，后台页⾯的内容全部放到body块中 3 数据库规范 所有的字段必须添加注释 字段名⼩写，多关键字使⽤下划线分割 （关键字尽量全称） 所有字段不允许 NULL值 字段长度定义 （TODO: 具体常⽤的长度定义） 数据表引擎 MyISAM 所有的表应该都有status 字段来标注数据状态，业务状态请使⽤其他字段；status字段 类型 为带符号的 tinyint -1 已删除 0 被禁⽤ 1 正常 2 未审核 如果还需要其他的数据状态 请先判断该状态的数据是有⽤的数据还是⽆意义的数据 有⽤的数据状态 2 ⽆意义的数据状态 -1 所有的删除 （除开清空回收站操作） 请 标记status 为 -1 4 ⽂档规范 功能模块⽂档 ⽂件注释 ⽅法注释 函数注释 代码块注释 注释必须有 @author 项，⽅便在遇到问题时候找到作者调整。 W3Cschool （ ）最⼤的技术知 分享与学习平台 此篇内容来⾃于 ⽹站⽤户上传并发布。