个人博客系统PHP编码规范V1.0.doc

个人博客系统 个人博客系统 第 page 5页/共 numpages 15页 NTS项目PHP编码规范 文档状态： [ ] 草稿 [ ] 正式发布 [√] 正在修改 [ ] 已废弃 文档编号： 文档版本： 1.0 文档属性： 内部 作 者： 杨家斌 日 期： 2012-02-10  文档修订记录 版本 日期 作者 描述（注明修改的条款和内容） 1.0 2012-02-10 杨家斌 创建 目录 TOC \o 1-3 \h \z \u 1 文件命名 4 2 源文件的编码规范 5 2.1 开头注释 5 2.2 引入语句 6 2.3 缩进排版 6 3 注释 6 3.1 块注释 6 3.2 文档注释 7 3.3 数据库注释 8 4 声明 8 4.1 每行声明的变量数量 8 4.2 类的声明 8 5 语句 9 5.1 简单的语句 9 5.2 复合的语句 9 5.3 if与else语句 9 6 空白 10 6.1 空行 10 7 命名规范 10 7.1 类 10 7.2 类属性的命名 10 7.3 函数 11 7.4 变量 11 7.5 常量 12 8 编程惯例 12 8.1 变量赋值 12 8.2 其他惯例 12 8.2.1 运算符?前的表达式 12 9 其它 13 文件命名 文件夹命名一般采用英文，长度一般不超过20个字符，命名采用小写字母。除特殊情况才使用中文拼音，不允许使用大写字母来命，可以减少windows和linux因文夹大小写原因引起的错误，一些常见的文件夹命名如： #设计部分 images (存放图形文件) flashs (存放Flash文件) css (存放CSS文件) js (存放Javascript脚本) medias (存放多媒体文件) docs (存放网站相关文档说明) #程序部分 controllers (控制器) interfaces (控制器) models (存放模型文件) views (存放模版文件) 如开发人员要建立目录请参考上述列出的命名。文件名称统一用小写的英文字母、数字组合。页面表现层的模版文件命名规则为“动作_对像.html”或“动作_类别_对像.html”例如： add_user.html //添加用户 add_user_score.html //添加用户积分 add_vipuser_score.html //添加高级会员用户积分 整体文件用.html命名，页面局布文件用.tpl命名，例如： PHP文件必须以.php结尾，如用.inc结尾直接访问服务器不去解析的话会直接把源码暴露出来 常用文件后缀参考： xxxxx.inc.php //包含文件 xxxx.php //控制器文件 xxxxx.conf.php //配置文件 xxxxx.func.php //函数文件 XxxxxModel.php //数据模型文件 XxxxxApi.php //接口文件 源文件的编码规范 说明：当有选择性内容时，用红字标明的地方为必写项 开头注释 所有的源文件都应该在开头有一个注释，这样有利于PHPDOC功具生成相应的文档，其中列出所属包、描述、版本信息、日期、作者、修改人后跟日期和版权声明例如： /** *简要说明 * @package demo //所属包 * @author liwenkai liwenkai@***.com //作者 * @version V1.0 //版本号 * @copyright Copyright (c) 2011, ***.com //版权 * @modifier lixiaochen lixiaochen@***.com //最后修改人 * @lastmodifide 2011/10/24 //最后修改日期 */ 参考截图： 如果对文件进行了修改，应该在文件头中说明修改目的、修改日期、修改人，并变更文件的版本信息；如果修改问文件的一部分，则在文件中进行注释即可，并且标识出修改部分的起止位置 引入语句 网站系统会配置是否开启自动引入功能，如开启自动加载功能，开发人员不需要手工引入类，直接new