Welcome to Kitchen Master!
说明:在厨神项目中使用了CI框架的架构,因为支持的终端有flash、PC浏览器、手机浏览器和手机WAP,因此要求在完成业务逻辑的程序代码中,严禁使用CI的类、函数,只能使用标准的PHP功能。对 CodeIgniter 不熟悉的请阅读 User Guide ,或中文版用户指南 (本地中文版 : 本地下载包)。
项目标准规范:/standard ,\\linux\km\standard。
管理后台:/home/cn/admin/
命名规范:
- 命名方法统一使用下划线命名法,如果名称由多个词组成,词之间要用下划线分隔。
- 名称由小写英文字母[a-z]、数字[0-9]、下划线[_]和点[.]组成,没有明确规定的禁止使用大写字母[A-Z]、中划线[-],绝对禁止使用空格[ ]、中文字符和其他字符。
- 类名的首字母应大写,其他字母小写。
- 方法名应完全小写,名称能明确指明用途,最好用动词开头。尽量避免过长和冗余的名称。方法名应有一致性,不同类中完成相同功能的方法,其名称应相同或相似。
- 函数名应完全小写,最好用名词开头,尽量使用有意义的标识,兼顾代码的可重用性,绝对不允许出现拼写错误。
文件目录结构:
- 目录 models: 模型,和数据库交互的,处理该模型业务逻辑的类,属于 class 。声明须加 extends Model 。文件名应该是模型类名的小写版。
- 目录 helpers: 辅助函数,完成特定任务的过程处理函数的集合,属于 function 。文件名小写。
- 目录 libraries: 类库,调用模型处理综合业务逻辑的类,属于 Class 。文件名和类名一样首字母大写,其他字母小写。
代码风格: 请使用PHP代码美化程序
- 文件格式,文件应使用 Unicode (UTF-8) 编码保存。同时不要使用字节序标记(BOM) 。使用 Unix 格式的行结束符(LF)。不含中文字符的纯程序文件可使用 ASCII 编码保存。
- PHP程序文件以长标签 "<?php" 表示程序开始,以避免短标签 "<?" 在不同的服务器配置环境下不能正常运行。文件底部禁止写闭合标签"?>",可加一段注释来标明这是文件的底部并定位这个文件在这个应用的相对路径。
- 代码风格类似 K&R C语言风格(详见附件)。PHP程序风格范例请参考 PHP Manual 中相关章节的代码。
- 严格遵守各标准规范的关键字,如HTML4.01、CSS2.0、JavaScript1.3、PHP5.0、Perl5.0等,绝不允许拼写错误。
- 缩进对齐:使用制表符,停止位为4个英文字符。同层代码左对齐,右大括号左对齐,左大括号推荐不另起一行。缩进最大不超过8层,否则需要修改代码结构。
- 空格:保留字、关键字、运算符空一格,单目运算符不空,括号内侧不空。类取成员操作符 "->" 不空,函数名与左小括号之间不空、右小括号与左大括号之间空一格。for语句中的各分句正常空格。
- 断行:一行一条语句。能不断行的尽量不断行,确实需要断行的,断行位置在运算符后。选择最合适的断行位置,做到既美观同时也能完整表达代码的意思。
- 空行:代码块内部适度空行,紧耦合度代码不空行、松耦合度代码空一行、模块之间或函数之间空二行、功能区域分隔空三行(二行或二行以上)。
- 常量名要全部用大写。TRUE, FALSE, 和 NULL 关键字应总是完全大写的。
- 逻辑运算符采用类C风格的 != && || ! ,不使用 <> and or not 。
- 使用双引号表示字符串"string",单引号表示单个字符'a';关联数组的键名统一使用单引号$ar_user['name']。
- SQL语句中SQL关键字及函数名均大写。不使用反引号包含数据库名、表名、字段名等。
- 代码中的注释侧重逻辑功能的解释。在大的注释块和代码间留一个空行。
- 定义函数时,如果指定参数的缺省值,请按照从右向左的参数顺序指定。
Page rendered in 0.0698 seconds