编码规范(一)之文本标记

来源:互联网 发布:腾跃网络 编辑:程序博客网 时间:2024/05/17 06:50

文本格式:
1. 文本标记

所有PHP文件,其代码标记均使用完整的PHP标签,不建议使用短标签,例如:

<span style="font-family:Microsoft YaHei;font-size:18px;"><?PHP      Echo ‘hello world!’;?><?</span>
<span style="font-family:Microsoft YaHei;font-size:18px;"><span style="white-space:pre"></span>//不建议使用      Echo ‘not suggest’;?></span>


使用短标签格式容易和XML混淆,并且不是所有的PHP版本和服务器都默认支持或打开短标签选项。

      对于只含有PHP代码的文件,将在文件结尾处忽略’?>’,这是为了防止多余空格或者其他字符影响到代码。

【提示】 这个问题会在不开启压缩和缓存时出现,可以在php.ini中设置。当一个目标文件中‘?>’后面有换行时,包含该目标的文件实际上会输出这个换行。这些换行会影响一些函数。比如session_start()前面不能有换行和空格。

2. 文件和目录命名

      程序文件名和目录名均采用有意义的英文命名,不使用拼音和无意义的字母,只允许出现字母数字下划线和中画线字符。

包含类命名:

DemoTest.class.php

接口统一采用:

DemoTest.interface.php

3. 文件目录结构

      在开发规范、独立的PHP项目时,使用规范的文件目录结构,有助于提高项目逻辑结构合理性,对于扩展和合作以及团队开发均有好处。

例如,通常如下:
——app         //独立的应用

——class       //单个类文件,公用的类文件

——conf/inc        //配置文件目录

——data        //数据文件目录

——doc         //程序相关文档

——htdocs          //document_root

——images          //所有图片文件存放路径

——css          //css文件

——js            //js脚本文件

——lib           //共用类库

——template       //模板文件

——temp       //临时文件

——upload         //上传文件

——manage        //后台管理文件存放目录

0 0
原创粉丝点击