开发规范
文章分页:
开发规范 - 1

命名规则

  • 类、方法及函数名称按照首字母小写的驼峰模式,如:myFunction()
  • 变量名称全部小写,单词间通过下划线间隔,如:$some_variant
  • 常量名称全部大些,单词间通过下划线间隔,如:WEB_ROOT
  • 类文件名按照首字母小写的驼峰模式,并以“.class.php”结尾,如:myClass.class.php
  • 类名称应与文件名保持一致,如文件名为 myClass.class.php 则类名就应为 myClass
  • 如果是类为代理模式,则在同一目录下建立对应名称的子目录,并包含“interface_myClass.class.php”的接口规则文件。

 

开发建议

  • 遵循框架的命名规范和目录规范;
  • 开发过程中尽量开启调试(debug)模式,及早发现问题;
  • 多看错误日志,查找隐患问题;
  • 利用myReq模块获取用户变量,过滤有害代码;
  • 更新或者环境改变后遇到问题,先尝试清空缓存(cache)目录。

 

命名空间

  • 框架主要功能模块均未设置命名空间,即直接处于根;
  • 所有应用除控制器扩展(即:应用名称.class.php)外,均需位于“app\应用名称”的命名空间内;
  • 插件类文件名称固定为"class.php",类名称为“plugin_插件名称”,不设置命名空间。

 

功能扩展

框架功能扩展可通过添加框架功能类,composer功能类或自定义功能类三种方式实现。

  • 添加框架功能库仅针对PHP功能,参考命名规则,只要按照对应标准要求,系统会在用到对应功能类时自动加载。
  • 通过 composer 添加的PHP功能类可自动加载,无需事先引用。
  • 添加第三方功能PHP功能类,可通过 myStep::vendor 方法声明实例,其中参数1为功能类信息名称,其他参数以此对应该功能类构造函数的各参数;
  • 添加第三方Javascript扩展(含composer扩展),需要遵循目录名、js文件名、css文件名保持一致,可通过 jQuery 的 vendor 方法调用,方法为: $.vendor(function(name, option)) 其中name为目录名,option包含三个参数:add_css 表示是否同时引入样式表(可为布尔值,或者".min"之类的文件名修正),name_fix 表示js文件名是否为 “.min.js” 的模式,callback 表示在成功引用完成对应功能扩展后所执行的方法。

 

其他规范

框架应用扩展插件相关开发规范请在对应章节查看。

 

上一篇:首次运行
下一篇:常量变量