分享

二次开发代码规范建议

 shopnc 2015-11-30
 经过前几篇的介绍,相信大家对ShopNC商城系统和它的代码结构有了一定的了解,有的甚至已经进行了部分二次开发,在此,本人对进行二次开发的同学提一些建议。

关于PHP书写:
1.      代码标记建议使用标准形式(<?php…… ?>),不建议使用简写形式(<? …… ?>),如果服务器未开启对短标记的支持(short_open_tag = Off),将会有暴露源码的危险。
2.      模板中输出变量使用“echo” 输出,以分号结尾,不建议使用“=”输出。
3.      对于函数级、类类及文件头注释使用C样式的注释“/* */”,对于代码行(段)的注释可使用标准C++注释”//”。
4.      建议使用缩进保持代码的层级关系,每个缩进的单位约定是一个TAB(4个空白字符宽度),开发工具建议使用Zend Studio、UltraEdit、EditPlus等编辑器。
5.      关于PHP变量的命名规则,建议以英文拼写为蓝本,遵循简洁和可读性原则,至于采用C风格还是Java风格还是其它,可跟据自己习惯,本人不做强制建议。
6.      全局常量的定义要统一使用大写,单词之间使用下划线连接。
7.      开发时,代码的error_reporting报错级别建议设置为E_ALL & ~E_NOTICE。
8.      Include,require包含文件时建议使用绝对路径,框架底层引入文件可使用Include,require(不带once效率高一些),在业务逻辑层引入文件时可使用Include_once,require_once。

关于数据库:
1.      表和字段命名同样应以英文拼写为蓝本,遵循简洁和可读性原则,长度适中,建议长度在30个字符内,否则跨库迁移可能会存在麻烦。
2.      字段类型设置应遵循足够用不浪费的原则。
3.      SQL语句中,除了表名、字段名称以外,全部语句和函数均应大写。
4.      尽可能避免直接编写SQL语句去执行,提倡使用系统数据库操作层相应入口来完成。
5.      索引可以加快检索速度,但不易过多,单个表建议不超过5个索引。

关于目录的安全:
1.      文件与目录命名均使用小写字母,php文件后缀均为“.php”,
2.      请在敏感目录中放置一个1字节的index.html文件,内容为一个空格,以避免当http服务器的Directory Listing打开时,服务器文件被索引和列表。
3.      根目录创建一个空格为内容的robots.txt文件,防止搜索蜘蛛抓取时,因找不到该文件而产生一个[error]信息而产生大量的无效WEB日志。

    本站是提供个人知识管理的网络存储空间,所有内容均由用户发布,不代表本站观点。请注意甄别内容中的联系方式、诱导购买等信息,谨防诈骗。如发现有害或侵权内容,请点击一键举报。
    转藏 分享 献花(0

    0条评论

    发表

    请遵守用户 评论公约

    类似文章 更多