我的PHP编码风格.docVIP

我的PHP编码风格 一、文件目录结构。 1. 目录名的规范。 目录的命名使用英文名词、动词，以及下划线，所有字母都使用小写字母。长度一般不超过20个字符。 例如： images(存放图形文件)，flash（存放Flash文件），style(存放CSS文件)，scripts（存放Javascript脚本），inc(存放include文件)， link（存放友情链接）,media(存放多媒体文件)等。 2. 文件名的规范。 文件名使用英文名词、动词，以及下划线，所有字母都使用小写字母。 例如：index.php、index_ad.html。 3. 用户编写的函数的规范。 (1). 用户编写的函数放置于include目录并以.func.php作为函数文件后缀，放置于include/function目录。 例：mytool.func.php、ip.func.php。 (2). 函数名使用小写字母、下划线组合。如：get_client_ip() 。 4. 类文件的命名规范。 用户编写的类，以 .class.php作为文件的后缀，放置在 include/class 目录。 例：MySql.class.php、Page.class.php。 函数库（function目录中的文件）和类库（class目录中的文件）程序只能被其他程序引用，而不能独立运行。 流程性文件、函数文件都是小写字母。而类文件采用驼峰式写法。 注：php4中的类文件，采用小写字母写法。如，db_mysql.class.php 、db_mssql.class.php等等。 5. 流程性程序的命名规范。 以小写.inc.php作为扩展名。只能被其他程序引用，而不能独立运行。其中不能包含任何函数或类代码的程序代码。 例：common.inc.php、config.inc.php。 6. 模板源文件 以小写.html作为扩展名。放置于./templates/default或./templates下的其他模板目录下。 例：./templates/default/index.html 7. 模板目标文件 模板文件被编译后自动生成的目标程序，以小写 .php作为扩展名，存放于./data/templates目录下。 例：./data/templates/index.php //此处的index.php是./templates/default/index.html编译过来的。 8. 语言包文件 以小写.lang.php作为扩展名，只能存放模板或程序使用的语言包信息。 9. 缓存文件 此类文件为系统自动生成，以cache_xxx.php、usergroup_xxx.php、style_xxx.php等类似形式命名，存放于./data/cache目录下。 10. PHP程序的后缀名 (1). 能够被URL直接调用的程序，例如list.php、index.php，直接使用程序名+.php的方式命名。 (2). 所有包含PHP代码的程序文件或半程序文件，应以小写.php作为扩展名，而不要使用.phtml、.php3、.inc、.class等作为扩展名。 11. HTML模板文件的规范 (1). HTML代码标记一律采用小写字母形式，杜绝任何使用大写字母的方式。 (2). 模板中所有的逻辑体，如{if}、{loop}等，必须前后使用HTML注释(!-- --)，即类似!--{if expr}--的形式。 加入注释可以使得模板可读性更好，同时方便用户使用DreamWeaver或FrontPage等对模板进行修改。 (3). html的form表单各个元素名称与数据库字段尽量保持一致。 12. 空目录索引 (1). 请在所有不包含普通程序(即能够被URL直接调用的程序)的目录中放置一个1字节的index.htm文件，内容为一个空格。 (2). 几乎除phpcms根目录以外，所有目录都属于这一类型，因此开发者需要在这些目录全部放入空index.htm文件，以避免当http服务器的 Directory Listing打开时，服务器文件被索引和列表。 (3). 附件目录等敏感目录，要在程序中实现相应功能，当新建下级目录时，必须自动写入一个空的index.htm文件，以避免新建目录被索引的 问题。 13. 包含文件规范。