BIWEB PHP编码规范指南

"BIWEB-PHP-编码规则.doc" 是一份关于BIWEB PHP项目的编码规范文档，由Arthur在不同时间点进行了多次修订。该文档详细规定了PHP开发中的命名规则、目录结构、文件处理、函数编写、常量与变量的使用、代码排版、数据编码、输入输出检查、SQL语句的编写、字符集设置、模板处理等多个方面的标准。 1. **命名规则**：所有命名均应使用英文，避免汉字，确保有意义且易理解。目录名和文件名全小写，以减少在Linux环境下的大小写问题。函数名首字母大写，变量名由多个单词组成时，每个单词首字母大写，且需添加小写变量类型的前缀。 2. **目录结构**：按功能划分目录，通过目录层级展示功能间的关联。文档中提到了整站配置、新闻栏目等不同部分的目录结构示例。 3. **文件**：文件编码统一为UTF-8，且关闭BOM功能，避免编辑器使用Windows记事本。文件名保持小写。 4. **函数**：函数名首字母大写，函数头需要清晰定义。 5. **常量**：未详述具体规则，但通常常量命名应全大写，用下划线分隔单词。 6. **变量**：变量名有特定的命名约定，前缀表示变量类型，如intVar、strVar等。 7. **排版**：提倡缩进编码风格，花括号{}的使用也有明确规则，以提高代码可读性。 8. **字符串引用**：推荐使用单引号，若需要包含变量则使用双引号。 9. **数据编码**：未详述具体方法，但通常涉及PHP的编码转换和数据类型处理。 10. **输入输出值检查**：强调对用户输入进行验证和过滤，防止安全问题。 11. **SQL语句**：要求编写安全的SQL语句，可能涉及预处理语句或参数化查询。 12. **字符集设置**：统一设置为`charset=UTF-8`，确保多语言支持。 13. **空行使用**：合理使用空行以增强代码可读性。 14. **Smarty模板**：有关模板结构和调用规则的说明。 15. **模板图片调用规则**：规范模板中图片资源的引用方式。 16. **模板文件存放规则**：指定了模板文件的组织方式。 17. **变量设定规则**：在不同功能栏目中变量的定义和使用有特定指导。 18. **区块Block的应用**：可能涉及模板引擎中的可复用代码块。 19. **配置变量命名规则**：针对配置文件中的变量有特定命名指导。 20. **底层主类调用**：详细说明如何调用基础类库。 21. **底层扩展函数调用**：规范自定义函数的调用方式。 22. **BIWEB文件调用关系**：描述了项目内部文件之间的依赖关系。 23. **URL静态优化配置**：提供了优化URL的方法，可能包括重写规则。 24. **URL静态优化调用文件**：涉及生成和处理静态URL的文件。 25. **纯静态文件生成**：描述如何创建和管理纯静态HTML页面。 26. **BIWEB虚拟主机完整配置文件**：给出了服务器配置的详细信息。 这份编码规范文档是为确保代码质量、可维护性和团队协作效率而制定，遵循这些规则能帮助开发者在BIWEB项目中保持一致性，降低出错概率，提升整体项目质量。