开发规范

来源:互联网 发布:java程序员自我评价 编辑:程序博客网 时间:2024/05/21 10:48

URL

默认的Yii的URL格式如下:

http://hostname/index.php?r=ControllerID/ActionID

ControllerID被Yii解析为控制器,CController::ActionID为动作

若ActionID省略则调用默认的defaultAction

若ControllerID省略则调用默认的CWebApplication::defaultController

 

代码

Yii 推荐命名变量、函数和类时使用 驼峰风格,即每个单词的首字母大写并连在一起,中间无空格。

变量名和函数名应该使它们的第一个单词全部小写,以使其区别于类名。

对私有类成员变量来说,推荐以下划线作为其名字前缀(例如: $_actionList)。

一个针对控制器名字的特殊规则是它们必须以单词 Controller 结尾。那么控制器 ID 即类名的首字母小写并去掉单词Controller。 例如,PageController 类的 ID 就是 page 。

 

文件

类文件应以它们包含的公有类命名。例如, CController 类位于 CController.php 文件中。

视图文件应以视图的名字命名。例如, index 视图位于 index.php 文件中。

配置文件可以任意命名。 配置文件是一个PHP脚本,它的主要目的是返回一个体现配置的关联数组。

 

目录

下面的目录是基于站点目录webRoot

WebRoot/protected: 这是 应用基础目录, 是放置所有安全敏感的PHP脚本和数据文件的地方。

WebRoot/protected/runtime: 此目录放置应用在运行时产生的私有临时文件。 此目录必须对 Web 服务器进程可写。

WebRoot/protected/extensions: 此目录放置所有第三方扩展。

WebRoot/protected/modules: 此目录放置所有的应用 模块,每个模块使用一个子目录。

WebRoot/protected/controllers: 此目录放置所有控制器类文件。

WebRoot/protected/views: 此目录放置所有试图文件, 包含控制器视图,布局视图和系统视图。

WebRoot/protected/views/ControllerID: 此目录放置单个控制器类中使用的视图文件。

WebRoot/protected/views/layouts: 此目录放置所有布局视图文件。

WebRoot/protected/views/system: 此目录放置所有系统视图文件。 系统视图文件是用于显示异常和错误的模板。

WebRoot/assets: 此目录放置公共资源文件。 资源文件是可以被发布的,可由Web用户访问的私有文件。此目录必须对 Web 服务器进程可写。 

WebRoot/themes: 此目录放置应用使用的不同的主题。每个子目录即一个主题,主题的名字即目录的名字。

 

数据库 

1.数据库表名和列名都使用小写命名。

2.名字中的单词应使用下划线分割 (例如 product_order)。

3.对于表名,你既可以使用单数也可以使用复数。但 不要 同时使用两者。为简单起见,我们推荐使用单数名字。

4.表名可以使用一个通用前缀,例如 tbl_ 。这样当应用所使用的表和另一个应用说使用的表共存于同一个数据库中时就特别有用。