PHP开发要求规范

合集下载

psr 规范

psr 规范

psr 规范PSR(PHP Standards Recommendations)是由PHP-FIG(PHP Framework Interop Group)组织制定的一系列PHP编码规范。

这些规范旨在为PHP开发人员提供统一的代码风格和最佳实践,以便增加代码的可读性、可维护性和可扩展性。

以下是对PSR规范的简要描述:1. PSR-1: 基本编码规范PSR-1规范主要定义了PHP代码的基本要求,包括文件命名空间、文件编码方式、类命名和文件自动加载规则等。

2. PSR-2: 代码风格指南PSR-2规范描述了PHP代码的一般样式规则,如缩进、行长度、命名约定、代码块间的空格等。

遵循这些规范可以提高代码的可读性和一致性。

3. PSR-3: 日志接口PSR-3规范定义了一套通用的日志接口,使得不同的日志库可以互相兼容。

该规范主要包括日志级别、记录消息和记录上下文等内容。

4. PSR-4: 自动加载规范PSR-4规范指定了类和命名空间之间的映射关系,使得自动加载类变得更加简单和可维护。

该规范要求将类的命名空间与文件路径结构一致。

5. PSR-6: 缓存接口PSR-6规范定义了一套通用的缓存接口,使得不同的缓存库可以互相兼容。

该规范主要包括缓存快照、读写操作和数据过期等内容。

6. PSR-7: HTTP消息接口PSR-7规范定义了一套通用的HTTP消息接口,包括请求和响应的处理、URI解析和文件上传等功能。

该规范使得不同的HTTP库可以互相兼容。

PSR规范的制定和推广对于提高PHP开发人员的编码质量和效率起到了积极的推动作用。

遵循PSR规范可以使代码更易于理解、维护和协作,也有助于提高整个开发团队的编码水平和一致性。

因此,对于PHP开发人员来说,熟悉并遵循PSR 规范是非常重要的。

软件开发规范

软件开发规范

软件开发规范一、引言在软件开发的过程中,规范的制定和遵守是确保项目顺利进行和提高开发效率的重要保障。

本文档旨在为软件开发人员提供一套规范指南,以确保软件开发过程的顺利进行和软件质量的提高。

二、代码规范1. 命名规范- 变量和函数名应具有描述性,避免使用无意义的单词或缩写。

- 使用驼峰命名法,例如:getUserName、calculateTotal。

- 避免使用拼音或缩写作为命名方式,应使用英文单词。

2. 注释规范- 在代码中适当使用注释,解释代码的功能、实现方式等。

- 使用清晰简洁的语言编写注释。

- 避免使用无效的注释或注释过多的情况。

3. 缩进与格式化- 使用统一的缩进规范,通常使用四个空格进行缩进。

- 注意代码的格式化,使其易于阅读和理解。

- 避免过长的代码行,应根据需要适当换行。

4. 错误处理- 合理处理异常和错误情况,避免程序出现异常崩溃等问题。

- 使用适当的日志记录错误信息,以便于排查和修复问题。

三、文档规范1. 需求规范- 准确记录软件的需求,包括功能需求、性能需求等。

- 使用简洁明了的语言表达需求,避免歧义。

- 需求应及时更新和维护,以适应项目的变化。

2. 设计规范- 采用模块化设计,将整个软件系统划分为不同的模块。

- 使用流程图、类图等工具来辅助设计和描述软件结构。

- 设计文档应详细描述各个模块的功能、接口、数据结构等。

3. 测试规范- 编写完善的测试计划和测试用例,以覆盖各种测试场景。

- 进行单元测试、集成测试、系统测试等不同层次的测试。

- 记录测试过程中出现的问题和不符合规范的地方,及时进行修复。

四、项目管理规范1. 时间管理- 制定合理的开发计划,合理安排时间和资源。

- 遇到问题及时沟通和协调,避免项目进度延误。

2. 团队协作- 遵守团队内部的协作规范,如代码版本管理、沟通协调方式等。

- 鼓励团队成员之间的知识分享和合作。

3. 文档管理- 统一管理项目相关文档,确保文档的及时更新和完整性。

php psr标准

php psr标准

php psr标准PSR是PHP Standard Recommendations的缩写,是一系列针对PHP语言的最佳实践和标准。

这些标准旨在确保PHP代码的可读性、可维护性和一致性,并促进不同开发人员之间的协作。

以下是PSR标准的一些重要方面:1. PSR-0(已废弃):PSR-0是已废弃的自动加载规范,它规定了如何自动加载PHP类文件。

该规范要求类文件的命名必须遵循特定的命名规则,以便通过自动加载机制正确加载类文件。

2. PSR-1:PSR-1是基础编码标准,它规定了PHP代码的基本格式和命名规则。

例如,它规定了类名、常量、函数和变量的命名规则,以及代码缩进和注释的用法等。

3. PSR-2:PSR-2是样式指南,它涵盖了PHP代码的样式和格式化规范。

它包括对代码缩进、注释、命名、空格和空行的使用等方面的规定。

4. PSR-3:PSR-3是日志记录接口,它定义了一个通用的日志记录接口,以便在不同的日志记录框架之间进行互操作。

这个标准有助于统一日志记录的输出格式和级别。

5. PSR-4:PSR-4是自动加载标准,它取代了PSR-0。

PSR-4规定了如何根据类名自动加载PHP类文件,以确保在不同的项目之间实现一致的自动加载机制。

6. PSR-5:PSR-5是注释规范,旨在标准化PHP代码注释的使用。

这个标准规定了注释的格式和内容要求,以帮助提高代码的可读性和可维护性。

7. PSR-6:PSR-6是缓存接口,它定义了一个通用的缓存接口,以便在不同的缓存实现之间进行互操作。

这个标准有助于统一缓存的存储和检索操作。

8. PSR-7:PSR-7是HTTP消息接口,它定义了HTTP请求和响应的接口。

这个标准使得PHP代码能够更加方便地处理HTTP请求和响应,并提高了不同框架之间的互操作性。

9. PSR-8:PSR-8是通用类型名,它规定了PHP中通用类型的名称和使用方式。

这个标准有助于统一不同框架和库之间的类型名称,提高代码的可读性和可维护性。

开发规范文档

开发规范文档

开发规范文档一、引言开发规范文档是为了规范开发人员在软件开发过程中的行为和规范,以确保软件开发的高效性和质量。

本文档旨在对开发规范进行详细说明,以便开发人员在日常工作中遵循。

二、命名规范1. 变量命名:变量名应具有描述性,能清晰表达其用途,采用驼峰命名法。

2. 函数命名:函数名应具有描述性,能清晰表达其功能,采用驼峰命名法。

3. 类命名:类名应具有描述性,能清晰表达其用途,采用驼峰命名法。

4. 文件命名:文件名应具有描述性,能清晰表达其内容,采用小写字母和下划线组合命名。

三、代码规范1. 缩进和空格:采用4个空格进行缩进,禁止使用Tab键。

2. 注释规范:代码中应有清晰的注释,注释应该对代码的功能、用途进行解释。

3. 异常处理:对可能出现的异常情况进行处理,避免程序崩溃。

4. 代码复用:尽量避免重复编写相同功能的代码,提取公共部分进行封装和复用。

四、数据库规范1. 表设计规范:数据库表应该具有清晰的结构设计,避免冗余和不必要的字段。

2. 索引规范:对经常用于查询的字段添加索引,提高数据库查询效率。

3. 数据备份规范:定期对数据库进行备份,以防数据丢失或损坏。

五、安全规范1. 数据加密:对用户的敏感信息进行加密存储,确保数据安全。

2. 权限控制:对不同角色的用户进行权限控制,确保用户只能访问其权限范围内的数据和功能。

3. 防止SQL注入:对用户输入的数据进行过滤和检验,避免SQL注入攻击。

六、测试规范1. 单元测试:对每个模块进行单元测试,确保模块功能的正确性。

2. 集成测试:对整个系统进行集成测试,确保各模块之间的协作正常。

3. 性能测试:对系统进行性能测试,确保系统在高并发情况下的稳定性和性能。

七、版本控制规范1. 版本命名规范:版本号应该具有一定的规范,能够清晰表达版本的变化和更新内容。

2. 分支管理规范:对不同的功能和模块进行分支管理,确保开发过程的清晰和有序。

八、总结开发规范文档对于软件开发团队的工作至关重要,遵循规范能够提高开发效率和质量,减少不必要的错误和问题。

开发规范与要求范文

开发规范与要求范文

开发规范与要求范文开发规范是一系列的编码原则、技术规范、文档规范等的集合,旨在确保团队开发的代码质量、可读性、可维护性、可扩展性,并提高团队合作效率。

本文将介绍开发规范的要求以及其对项目开发的重要性。

一、命名规范1.变量、函数、方法的命名应具有清晰的表达意义,使用有意义的英文单词或单词的组合。

2.类名、接口名应使用名词或名词词组,并使用大写开头的驼峰命名法。

3.常量名应使用大写字母加下划线的形式,如:MAX_COUNT。

4.避免使用容易混淆的命名,如:i1,l1,O0等。

二、缩进与排版规范1. 使用合适的缩进风格,如四个空格或一个Tab,统一团队内部的缩进风格。

2.代码块的开始和结束要与其对应的可见的包含结构对齐。

3.行宽应控制在80-120个字符之间。

三、代码注释规范1.对于代码中的每个模块或功能,必须提供必要的注释说明。

2.注释应简明扼要、准确清晰,解释代码的关键逻辑以及设计思想。

3.注释应使用英文书写,并遵循一定的规范,如在注释前使用特定的修饰符以区分说明的对象。

四、代码规范1.遵循单一职责原则,每个函数、方法只负责一个功能,尽量避免一个函数或方法实现多种功能。

2.遵循开闭原则,尽量使用扩展而非修改已有的代码。

3.避免使用变量的魔法数值,应提取为常量或配置项。

4.代码尽量简单清晰,可读性强,避免冗余的代码和复杂的逻辑结构。

五、测试规范1.编写单元测试代码,保证代码的正确性和稳定性。

2.合理组织测试用例,覆盖代码的各种情况,包括正常情况和异常情况。

3.定期运行测试用例,及时发现和解决问题,确保程序的健壮性。

六、文档规范1.编写开发文档和用户文档,清晰描述程序的设计思路、开发流程、代码的使用方法等。

2.文档内容应准确、详尽,方便其他开发人员和用户了解项目的细节。

开发规范对于项目开发具有重要的作用:1. 提高代码质量和可维护性:规范的代码易于阅读和理解,减少错误和bug的产生,提高代码的可维护性和可读性。

PHP开发工程师岗位要求5个

PHP开发工程师岗位要求5个

PHP开发工程师岗位要求5个岗位要求1:1、本科及以上学历,计算机/数学/软件工程/或相关理工科专业;2、有良好的代码书写和编程习惯,逻辑思维能力强;3、具有优秀的创新精神、钻研新技术的兴趣和能力,有较强的学习能力、沟通能力和高度的责任感。

岗位要求2:1、精通office等基础办公软件;2、熟悉HTML,css,JavaScript,AJAX等Web前端开发基础3、精通PHP脚本语言技术,熟悉使用thinkPHP、CL、Laravel 等框架之一4、计算机相关专业毕业,具备良好的团队合作精神5、具有较强的责任心,独立分析和解决问题的能力,服从领导交办的工作安排岗位要求3:1、1年以上PHP开发经验!2、精通PHP+MySQL开发技术,精通php的面向对象编程,熟悉主流的tp等框架,具有良好的编码习惯,良好的沟通能力,具有较强的分析、解决问题的能力。

3、精通小程序开发;4、熟练使用SQL、MySQL数据库。

5、对Linux、Windows服务器维护有一定了解。

岗位要求4:1、一年以上开发经验,有企业级应用开发经验;2、精通PHP开发语言,有TP或类似框架的实际项目经验,熟练使用PHP相关开发工具;3、熟悉PHP等相关技术;4、熟悉MySQL等数据库开发、SQL性能调优;5、熟练掌握常用的Linux命令、、shell脚本,Windows、Server 的各项服务、应用配置;6、有良好的代码书写、注释和单元测试习惯,熟练运用多种软件设计模式;7、具备良好的沟通合作技巧,较强的责任心及团队合作精神。

岗位要求5:1、1年以上PHP、Mysql实际开发工作经验;2、熟练使用laravel开发框架、Git;3、熟练使用Redis、消息队列、Elasticsearch等常用技术;4、熟悉linux常用命令;5、独立创造性的思维和解决问题的能力;6、拥有良好的代码习惯,有撰写设计文档的习惯;7、具备良好的沟通能力,团队合作意识,做事有条理,工作积极主动、严谨负责,有自我否定的勇气。

软件开发相关规范

软件开发相关规范

软件开发相关规范在软件开发领域,规范性十分重要。

严格的规范不仅能够提高开发效率,减少出错率,还能保证代码的可重用性、可维护性和可扩展性。

本文将从代码、文档和工作流程三个方面讨论软件开发的相关规范。

一、代码规范代码规范是指编写代码时应遵循的标准和规范,主要包括命名规范、注释规范、代码风格规范等。

命名规范要求变量、函数、类、模块等的命名符合一定的命名规范。

变量名要具有描述性,有利于代码的可读性和理解性。

函数名应具有行为描述性,命名要简单明了,不要使用缩写。

类名要使用名词,并使用大写开头的驼峰命名法。

注释规范是编写代码时必不可少的一项规范,它能够使代码更加易读易懂,提高代码的可维护性。

注释应包括以下内容:函数描述、参数解释、返回值描述、异常情况解释等。

代码风格规范是一项非常重要的规范,代码风格的好坏影响着可读性和理解性。

代码风格规范要求代码应该缩进规范、使用空格缩进、使用大括号等符号的位置规范。

二、文档规范文档规范是指编写文档时应遵循的标准和规范,主要包括需求文档、设计文档、测试文档等。

在编写需求文档时,要尽量简洁明了,每个需求用一句话描述。

需求应该具有可衡量性和可测试性,要求明确、完整、不模棱两可。

在编写设计文档时,需要详细描述软件系统的结构、组件和模块之间的关系。

需要描述系统的架构、每个模块的接口、输入和输出参数以及异常情况等。

在编写测试文档时,需要详细描述每一个测试用例的执行步骤、期望的结果和预期的执行时间等信息。

测试用例应该具有可重复性、可验证性和可测量性。

三、工作流程规范工作流程规范是指团队成员在工作中应遵循的标准和规范,主要包括需求流程、设计流程、代码开发流程、代码审核流程和测试流程等。

需求流程是指软件项目需求规划、需求收集和分析、需求文档编写、需求确认等一系列流程。

在需求流程中,应该注重与客户之间的沟通,保证需求的准确性和完整性。

设计流程是指软件项目的总体设计、模块设计、界面设计、数据库设计等一系列流程。

psr标准

psr标准

psr标准标题:PSR标准概述及实践指南---**一、引言**PSR是PHP Standards Recommendations的缩写,是由PHP-FIG(PHP Framework Interop Group)制定的一系列PHP编程规范。

这些规范旨在提升PHP项目的可维护性、互操作性和一致性,减少开发者在不同框架和库之间切换时的学习成本,提高团队协作效率。

**二、PSR标准分类**1. **编码规范**:- PSR-1 基础编码规范:定义了PHP代码的基础编码规范,包括类名、文件名、常量命名等。

- PSR-2 编码风格规范:详细规定了PHP代码的格式化规则,如缩进、空格、花括号使用等。

2. **自动加载规范**:- PSR-0 自动加载规范(已废弃):早期定义了如何通过类名或命名空间来定位文件的规范。

- PSR-4 自动加载规范:替代PSR-0,提供了基于命名空间的类自动加载机制。

3. **HTTP消息接口**:- PSR-7 HTTP消息接口:定义了一套统一的HTTP请求和响应对象接口。

4. **HTTP中间件**:- PSR-15 HTTP中间件规范:定义了HTTP中间件接口,方便处理请求和生成响应。

5. **依赖注入容器接口**:- PSR-11 通用容器接口:提供了一个通用的容器接口,用于存储和检索对象实例。

6. **日志接口**:- PSR-3 日志接口:定义了一种通用的日志记录接口以及一套预定义的日志级别。

**三、PSR标准实践**遵循PSR标准,不仅可以使你的项目代码更加整洁、易读,还能使得项目更好地与其他遵循相同规范的第三方库和框架兼容。

例如,在项目中实施PSR-4自动加载规范,可以简化类的加载过程;采用PSR-3日志接口,可以轻松替换不同的日志实现。

对于开发团队而言,应将PSR标准纳入内部编码规范,并在项目初始化阶段就进行严格遵循。

同时,利用自动化工具(如PHP_CodeSniffer, PHP-CS-Fixer 等)对代码进行检查和格式化,能有效保证代码质量并降低人工审查成本。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

目录1、编写目的 (4)2、整体要求 (5)3、安全规 (6)3.1、包含文件 (6)3.1.1、命名规则 (6)3.1.2、存放规则 (6)3.2、安全规则 (6)3.3、一些针对PHP的规则 (7)3.4、其它处理规则 (7)3.4.1、输入参数处理 (7)3.4.2、操作大HTML文本 (8)4、编码规 (9)4.1、命名规 (9)4.1.1、变量命名 (9)4.1.2、类命名 (10)4.1.3、方法或函数 (10)4.1.4、缩写词 (10)4.1.5、数据库表名 (10)4.1.6、数据库字段 (11)4.2、书写规则 (11)4.2.1、代码缩进 (11)4.2.2、大括号{}书写规则 (11)4.2.3、小括号()和函数、关键词等 (12)4.2.4、=符号书写 (12)4.2.5、if else swith for while等书写 (12)4.2.6、类的构造函数 (12)4.2.7、语句断行 (13)4.2.8、数字 (13)4.2.9、判断 (14)4.2.10、避免嵌入赋值 (14)4.2.11、错误返回检测规则 (14)4.3、程序注释 (14)4.3.1、程序头注释块 (14)4.3.2、类的注释 (15)4.3.3、函数和方法的注释 (16)4.3.4、变量或者语句注释 (16)4.4、其它规 (17)4.4.1、PHP代码标记 (17)4.4.2、程序文件名、目录名 (17)4.4.3、PHP项目通常的文件目录结构 (17)4.4.4、PHP和HTML代码的分离问题 (17)4.4.5、PHP项目开发中的程序逻辑结构 (18)5、特定环境下PHP编码特殊规 (19)5.1、变量定义 (19)5.2、引用的使用 (19)5.3、变量的输入输出 (19)1、编写目的为了更好的提高技术部的工作效率,保证开发的有效性和合理性,并可最大程度的提高程序代码的可读性和可重复利用性,指定此规。

开发团队根据自己的实际情况,可以对本规进行补充或裁减。

1、程序员可以了解任何代码,弄清程序的状况;2、新人可以很快的适应环境;3、防止新接触PHP的人出于节省时间的需要,自创一套风格并养成终生的习惯;4、防止新接触PHP的人一次次的犯同样的错误;5、在一致的环境下,人们可以减少犯错的机会;6、程序员们有了一致的敌人;2、整体要求技术部php开发规将参照PEAR的规,基本采用PEAR指定的规,在其基础上增加、修改或删除部分适合具体开发环境的规。

本规只针对PHP开发过程中编码的规,对于PHP开发项目中文件、目录、数据库等方面的规,将不重点涉及。

本规包含了PHP开发时程序编码中命名规、代码缩进规则、控制结构、函数调用、函数定义、注释、包含代码、PHP标记、文件头的注释块、CVS标记、URL样例、常量命名等方面的规则。

3、安全规当我们尝试编码时,很多时候不知道如何去让自己的代码变得安全一点,因为我们缺乏安全常识,安全常识的规可以帮你杜绝一些日常的菜鸟黑客的攻击,却不能阻止骨灰级专家们的凌厉攻势,所以更高深的安全我们还得从其他途径学习。

3.1、包含文件PHP文件的包含在通过PHP的函数引入文件时,由于传入的文件名没有经过合理的校验,从而操作了预想之外的文件,就可能导致意外的文件泄露甚至恶意的代码注入。

3.1.1、命名规则提取出来具有通用函数的包含文件,文件后缀以 .inc 来命名,表明这是一个包含文件。

如果有多个 .inc 文件需要包含多页面,请把所有 .inc 文件封装在一个文件里面,具体到页面只需要包换一个 .inc 文件就可以了。

如: xxx_session.inc 、 xxx_comm.inc 、 xxx_setting.inf 、myssql_db.inc 。

把以上文件以以下方式,封装在 xxx.basic.inc 文件里面:注意:是否需要封装到一个文件,视情况而定,如果每个 inc 的功能是分散到不同的页面使用的话,就不建议封装。

3.1.2、存放规则一般包含文件不需要直接暴露给用户,所以应该放在 Web Server 访问不到的目录,避免因为配置问题而泄露设置信息。

3.2、安全规则请参考产品安全检查表。

输入和输出:检查是否做了HTML代码的过滤可能出现的问题:如果有人输入恶意的HTML代码,会导致窃取cookie, 产生恶意登录表单,和破坏。

检查变量做数据库操作之前是否做了 escape可能出现的问题:如果一个要写入查询语句的字符串变量包含了某些特殊的字符,比如引号(',")或者分号(;) 可能造成执行了预期之外的操作。

建议采用的方法:使用 mysql_escape_string() 或实现类似功能的函数。

检查输入数值的合法性可能出现的问题:异常的数值会造成问题。

如果对输入的数值不做检查会造成不合法的或者错误的数据存入UDB、存入其它的数据库或者导致意料之外的程序操作发生。

举例:如果程序以用户输入的参数值做为文件名,进行文件操作,恶意输入系统文件名会造成系统损毁。

核实对cookie的使用以及对用户数据的处理可能出现的问题:不正确的cookie使用可能造成用户数据泄漏。

访问控制对部使用的产品或者供合作方使用的产品,要考虑增加访问控制。

logs确保用户的信息没有记在log中(例如:用户的密码);确保对关键的用户操作保存了完整的用户访问记录。

https对敏感数据的传输要采用https。

3.3、一些针对PHP的规则设置 register_globals = off ;设置 error_reporting = E_ALL ,并且要修正所有的 error 和warning ;将实际的操作放在被引用的文件中。

把引用文件放到不可以被直接浏览的目录下。

register_globals 已自 PHP 5.3.0 起废弃并将自 PHP 5.4.0 起移除。

3.4、其它处理规则其它处理规则3.4.1、输入参数处理页面接到参数需要SQL操作,这时候需要做转义,尤其需要注意“'”。

如:这种情况出现错误的不确定性。

3.4.2、操作大HTML文本很多时候需要存放一大段HTML文本供页面使用,象用户定制页头页脚等。

需要剔除脚本标记,避免执行恶意php代码。

转换“<”“>”号,保证代码完整 HTML 文本。

4、编码规对代码文件及代码进行规化。

4.1、命名规制定统一的命名规对于项目开发来说非常重要,不但可以养成程序员一个良好的开发习惯,还能增加程序的可读性、可移植性和可重用性,还能很好的提高项目开发的效率。

4.1.1、变量命名**变量命名分为普通变量、静态变量、局部变量、全局变量、Session变量等方面的命名规则。

1.普通变量普通变量命名遵循以下规则:a.所有字母都使用小写;b.对于一个变量使用多个单词的,使用 _ 作为每个词的间隔。

例如: $base_dir 、 $red_rose_price 等。

2.静态变量静态变量命名遵循以下规则:a.静态变量使用小写的 s_ 开头;b.静态变量所有字母都使用小写;c.多个单词组成的变量名使用 _ 作为每个词的间隔。

例子: $s_base_dir 、 $s_red_rose_prise 等。

3.局部变量局部变量命名遵循以下规则:a.所有字母使用小写;b.变量使用 _ 开头;c.多个单词组成的局部变量名使用 _ 作为每个词间的间隔。

例子: $_base_dir 、 $_red_rose_price 等。

4.全局变量全局变量应该带前缀 G_ 且所有字母大写,知道一个变量的作用域是非常重要的。

例如:5.全局常量全局变量命名遵循以下规则:a.所有字母使用大写;b.全局变量多个单词间使用 _ 作为间隔。

例子:6.session变量session变量命名遵循以下规则:a.所有字母使用大写;b.session变量名使用 S_ 开头;c.多个单词间使用 _ 间隔。

例子: $S_BASE_DIR 、 $S_RED_ROSE_PRICE 等。

4.1.2、类命名PHP中类命名遵循以下规则:a.以大写字母开头;b.多个单词组成的变量名,单词之间不用间隔,各个单词首字母大写。

例子: class MyClass 或 class DbOracle 等。

4.1.3、方法或函数方法或函数命名遵循以下规则:a.首字母小写;b.多个单词间不使用间隔,除第一个单词外,其他单词首字母大写。

例子: function myFunction() 或 function myDbOracle() 等。

4.1.4、缩写词当变量名或者其他命名中遇到缩写词时,参照具体的命名规则,而不采用缩写词原来的全部大写的方式。

例子: function myPear (不是myPEAR) functio getHtmlSource (不是getHTMLSource)。

4.1.5、数据库表名数据库表名命名遵循以下规:a.表名均使用小写字母;b.对于普通数据表,使用 _t 结尾;c.对于视图,使用 _v 结尾;d.对于多个单词组成的表名,使用 _ 间隔;例子: user_info_t 和 book_store_v 等。

4.1.6、数据库字段数据库字段命名遵循以下规:a.全部使用小写;b.多个单词间使用 _ 间隔。

例子: user_name 、 rose_price 等。

4.2、书写规则书写规则是指在编写 PHP 程序时,代码书写的规则,包括缩进、结构控制等方面规。

4.2.1、代码缩进在书写代码的时候,必须注意代码的缩进规则,我们规定代码缩进规则如下:a.使用4个空格作为缩进,而不使用tab缩进(对于 ultraedit ,可以进行预先设置)。

例子:4.2.2、大括号{}书写规则在程序中进行结构控制代码编写,如 if 、 for 、 while 、 switch 等结构,大括号传统的有两种书写习惯,分别如下:a. { 直接跟在控制语句之后,不换行,如:b. { 在控制语句下一行,如:其中,a是 PEAR 建议的方式,但是从实际书写中来讲,这并不影响程序的规和影响用 phpdoc 实现文档,所以可以根据个人习惯来采用上面的两种方式,但是要求在同一个程序中,只使用其中一种,以免造成阅读的不方便。

为了统一书写,请使用 a 的书写方式。

4.2.3、小括号()和函数、关键词等小括号、关键词和函数遵循以下规则:a.不要把小括号和关键词紧贴在一起,要用一个空格间隔;如 if( $a<$b ) ;b.小括号和函数名间没有空格;如 $test = date("ymdhis") ;c.除非必要,不要在 Return 返回语句中使用小括号。

如 Return$a ;4.2.4、=符号书写在程序中 = 符号的书写遵循以下规则:a.在 = 符号的两侧,均需留出一个空格;如 $a = $b 、 $a ='test' 等;b.在 = 符号与 ! 、 = 、 < 、 > 等符号相邻时,不需留一个空格;如 if ( $a == $b ) 、 if ( $a != $b ) 等;c.在一个申明块,或者实现同样功能的一个块中,要求 = 号尽量上下对其,左边可以为了保持对齐使用多个空格,而右边要求空一个空格;如下例:4.2.5、if else swith for while等书写对于控制结构的书写遵循以下规则:a.在 if 条件判断中,如果用到常量判断条件,将常量放在等号或不等号的左边,例如: if ( 6 == $errorNum ) ,因为如果你在等式中漏了一个等号,语法检查器会为你报错,可以很快找到错误位置,这样的写法要注意;b. switch 结构中必须要有 default 块;c.在 for 和 wiile 的循环使用中,要警惕 continue 、break 的使用,避免产生类似 goto 的问题;4.2.6、类的构造函数如果要在类里面编写构造函数,必须遵循以下规则:a.不能在构造函数中有太多实际操作,顶多用来初始化一些值和变量;b.不能在构造函数中因为使用操作而返回 false 或者错误,因为在声明和实例化一个对象的时候,是不能返回错误的;4.2.7、语句断行在代码书写中,遵循以下原则:a.尽量保证程序语句一行就是一句,而不要让一行语句太长产生折行;b.尽量不要使一行的代码太长,一般控制在120个字符以;c.如果一行代码太长,请使用类似 .= 的方式断行书写;d.对于执行数据库的 sql 语句操作,尽量不要在函数写 sql 语句,而先用变量定义 sql 语句,然后在执行操作的函数中调用定义的变量;例子:4.2.8、数字一个在源代码中使用了的赤裸裸的数字是不可思议的数字,因为包括作者,在三个月,没人知道它的含义。

相关文档
最新文档