PHP代码编写规范
phpstorm 格式化规则-概述说明以及解释
phpstorm 格式化规则-概述说明以及解释1.引言1.1 概述在PHPStorm中，格式化规则是指定义代码风格和排版的规则，以确保团队成员在编写和阅读代码时有一致的体验。
通过设置格式化规则，可以提高代码的可读性和统一性，减少因个人编码风格差异而导致的代码混乱问题。
本文将介绍PHPStorm的格式化规则，包括如何设置和应用这些规则，以及其在代码编写过程中的优势和重要性。
1.2 文章结构文章结构是指文章的篇章组织和段落构成，它对于整篇文章的逻辑性和连贯性起着至关重要的作用。
一个良好的文章结构可以使读者更好地理解文章内容，抓住主题思想，理清思路。
文章结构通常包括引言、正文和结论三部分。
其中引言部分介绍文章的主题和背景，引起读者的兴趣，正文部分是文章的主体部分，展开论述和阐述观点，结论部分总结全文内容，给出自己的看法和建议。
在本篇文章中，我们首先介绍了PHPStorm的概述和目的，然后在正文部分详细介绍了PHPStorm的简介和格式化规则，以及这些规则的优势。
最后在结论部分对全文内容进行总结，并提出应用建议和展望未来的发展方向。
通过以上结构的安排，本文将会更加清晰地呈现出PHPStorm格式化规则的相关内容，为读者提供更好的阅读体验。
1.3 目的PHPStorm是一款功能强大的集成开发环境，其格式化规则对于代码的可读性和整洁性至关重要。
本文的目的是介绍PHPStorm的格式化规则，帮助读者了解如何通过这些规则来提高代码的质量和可维护性。
我们将详细讨论PHPStorm的格式化规则及其优势，指导读者如何有效地使用这些规则来优化他们的代码编写过程。
通过本文的介绍，读者将能够更好地利用PHPStorm的功能，提高代码的质量和效率，从而更好地应对软件开发的挑战。
2.正文2.1 PHPStorm简介PHPStorm是一款由JetBrains开发的集成开发环境（IDE），专门用于PHP语言开发。
它提供了丰富的功能和工具，帮助开发人员提高工作效率和代码质量。
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 规范是非常重要的。
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中通用类型的名称和使用方式。
这个标准有助于统一不同框架和库之间的类型名称，提高代码的可读性和可维护性。
psr规范
psr规范PSR（PHP Standard Recommendation）是PHP FIG （Framework Interop Group）提出的一系列关于编码风格、代码规范和最佳实践的建议。
下面将详细介绍PSR规范的一些重要内容。
一、命名规范1. 命名空间使用大写字母，其中每个单词首字母大写（例：NamespaceName）。
2. 类和接口的命名遵循骆驼拼写法，首字母大写（例：ClassName）。
3. 方法和属性的命名同样遵循骆驼拼写法，首字母小写（例：methodName，propertyName）。
4. 常量的命名全部大写，使用下划线分隔单词（例：CONSTANT_NAME）。
二、代码风格1. 使用四个空格缩进来表示代码块。
2. 方法之间留一个空行，类的成员之间也要留一个空行。
3. 使用大括号将代码块括起来，左大括号不另起一行。
4. if、else、while、for等关键字后加一个空格。
5. 算术运算符、赋值运算符和比较运算符两侧加一个空格。
三、注释规范1. 在代码的关键部分加上注释，解释代码的意图和作用。
2. 注释使用PHPDoc格式，包括类、方法、属性的注释。
3. 注释的第一行用来简要描述该代码的作用。
4. 注释块之前用一个空行隔开。
四、错误处理1. 使用try-catch语句来处理异常。
2. 抓住特定的异常，根据不同的异常类型执行不同的处理逻辑。
3. 在捕获异常时，尽量不要简单地输出异常堆栈信息，而是提供有意义的提示。
五、自动加载规范1. 使用PSR-4规范来加载类文件。
2. 每个命名空间必须有一个对应的基础目录。
3. 类的命名空间必须和目录结构一致。
六、测试规范1. 使用PHP的内置测试框架PHPUnit来编写和运行测试。
2. 测试代码必须位于tests目录下。
3. 测试文件名和测试类名必须和被测试的类名保持一致，以Test作为后缀。
以上是PSR规范的一些重要内容，遵循这些规范可以提高代码的可读性、可维护性和可扩展性，有利于多人协作开发。
PHPCMS开发文档里看到PHP编码规范
PHPCMS开发文档里看到PHP编码规范注：这是从PHPCMS开发文档里看到编码规范，虽名为PHPCMS的开发规范，但我觉得所有的PHP编程都该如此。
写了那么多PHP，很多编码对照这规范都感觉欠缺很多，今后一定要对照纠正。
Phpcms 编码规范1. 引言 (2)2. 适用范围 (2)3. 标准化的重要性和好处 (3)4. PHP编码规范与原则 (3)4.1. 代码标记 (3)4.2. 注释 (3)4.3. 书写规则 (4)4.3.1. 缩进 (4)4.3.2. 大括号{}、if和switch. 44.3.3. 运算符、小括号、空格、关键词和函数 (5)4.3.4. 函数定义 (6)4.3.5. 引号 (6)4.3.6. 多语言问题 (7)4.4. 命名原则 (8)4.4.1. 变量、对象、函数名 (8)4.4.2. 常量 (8)4.5. 变量的初始化与逻辑检查 (8)4.6. 安全性 (9)4.7. 兼容性 (9)4.8. 代码重用 (10)4.9. 其他细节问题 (10)4.9.1. 包含调用 (10)4.9.2. 错误报告级别 (11)5. 数据库设计 (11)5.1. 字段 (11)5.1.1. 表和字段命名 (11)5.1.2. 字段结构 (11)5.2. SQL语句 (12)5.3. 性能与效率 (13)5.3.1. 定长与变长表 (13)5.3.2. 运算与检索 (13)5.3.3. 结构优化与索引优化 (14)5.3.4. 查询优化 (14)5.3.5. 兼容性问题 (16)6. 模板设计 (16)6.1. 代码标记 (16)6.2. 书写规则 (16)6.2.1. HTML. 166.2.2. 变量 (16)6.2.3. 语言元素 (17)6.2.4. 缩进 (17)7. 文件与目录 (17)7.1. 文件命名 (17)7.2. 目录命名 (18)7.3. 空目录索引 (18)1. 引言本规范由编程原则组成，融合并提炼了开发人员长时间积累下来的成熟经验，意在帮助形成良好一致的编程风格。
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 等）对代码进行检查和格式化，能有效保证代码质量并降低人工审查成本。
psr规范
psr规范PSR 规范是 PHP 社区制定的规范和标准，以促进开发人员编写出更具可读性、可维护性和可重用性的 PHP 代码。
PSR 是PHP Standard Recommendation 的缩写，意为 PHP 标准建议。
今天我来详细介绍一下 PSR 规范。
PSR 规范的目标是提供一套统一的规范，使 PHP 代码可以跨不同的项目和开发团队之间进行共享和协作。
这样做有助于提高代码的质量、减少维护成本，并提供一致的开发体验。
PSR 规范分为多个不同的部分，每个部分都涵盖了不同方面的规范。
以下是其中一些重要的部分：1. PSR-1：基本编码规范这个规范定义了 PHP 代码的基本结构和编码风格。
它要求使用 <?php 标记开始 PHP 代码，禁止使用闭合标记 ?>。
此外，还规定了类名使用 StudlyCase 命名法，方法名和属性名使用camelCase 命名法，常量名使用全大写字母和下划线。
此外，还规定了对代码缩进使用四个空格，并要求遵循一些常见的编码约定。
2. PSR-4：自动加载规范这个规范定义了如何组织和加载 PHP 类文件。
它要求将每个命名空间与一个根目录对应起来，类文件名必须与类名一致，并按照目录结构进行存储。
PSR-4 规范简化了代码的自动加载过程，使得在项目中使用类自动加载更加方便和统一。
3. PSR-12：扩展的编码风格规范这个规范扩展了 PSR-1 中的编码风格要求，提供了更详细的编码规范。
它包括对代码缩进、空白行、注释、命名空间、类和方法的结构等方面的具体规定。
PSR-12 旨在进一步统一PHP 代码的编码风格，简化代码的维护和阅读。
除了上述几个主要的规范外，还有一些其他的 PSR 规范，如PSR-2（已废弃，合并到 PSR-12 中）、PSR-3（日志接口）、PSR-6（缓存接口）等。
每个规范都有其特定的目的和规定，开发者可以根据自己的需求选择适合的规范。
遵循 PSR 规范的好处是明显的。
PHP Document 代码注释规范
done
Operation Completed!! 然后，我们就可以通过查看生成的文档了，如果是 pdf 格式的，名字默认为 documentation.pdf。
4．给 php 代码添加规范的注释
PHPDocument 是从你的源代码的注释中生成文档，因此在给你的程序做注释的过程， 也就是你编制文档的过程。
PHP Document 代码注释规范
PHPDocumentor 是一个用 PHP 写的工具，对于有规范注释的 php 程序，它能够快速 生成具有相互参照,索引等功能的 API 文档。老的版本是 phpdoc。
1. 什么是 phpDocumentor ?
PHPDocumentor 是一个用 PHP 写的工具，对于有规范注释的 php 程序，它能够快速 生成具有相互参照,索引等功能的 API 文档。老的版本是 phpdoc，从 1.3.0 开始，更名为 phpDocumentor，新的版本加上了对 php5 语法的支持，同时，可以通过在客户端浏览器上 操作生成文档，文档可以转换为 PDF,HTML,CHM 几种形式，非常的方便。
/** * 函数 add,实现两个数的加法 * * 一个简单的加法计算，函数接受两个数 a、b，返回他们的和 c * * @param int 加数 * @param int 被加数 * @return integer */ function Add($a, $b) { return $a+$b; }
{@source} 显示一段函数或方法的内容 6．一些注释规范 a.注释必须是 /** * XXXXXXX */ 的形式 b.对于引用了全局变量的函数，必须使用 glboal 标记。 c.对于变量，必须用 var 标记其类型（int,string,bool...） d.函数必须通过 param 和 return 标记指明其参数和返回值 e.对于出现两次或两次以上的关键字，要通过 ingore 忽略掉多余的，只保留一个即可 f.调用了其他函数或类的地方，要使用 link 或其他标记链接到相应的部分，便于文档的阅读。 g.必要的地方使用非文档性注释，提高代码易读性。 h.描述性内容尽量简明扼要，尽可能使用短语而非句子。 i.全局变量，静态变量和常量必须用相应标记说明 7. 总结 phpDocumentor 是一个非常强大的文档自动生成工具，利用它可以帮助我们编写规范的注释，生成 易于理解，结构清晰的文档，对我们的代码升级，维护,移交等都有非常大的帮助。 关于 phpDocumentor 更为详细的说明，可以到它的官方网站 /查阅 8．附录 附录 1: 能够被 phpdoc 识别的关键字： Include Require include_once require_once define function global class 附录 2 文档中可以使用的标签 <b> <code> <br> <kdb> <li> <pre> <ul> <samp> <var>
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
QC 质量管理体系文件代码编写规范受控状态：■受控□非受控发布日期：2006年02月20日实施日期：2006年02月24日1. 引言1.1. 目的制定本规范是为了能达到以下目的：●提高程序员工作效率和代码的利用性●程序员可以了解任何代码，弄清程序的状况●新人可以很快的适应环境●防止新接触php的人出于节省时间的需要，自创一套风格并养成终生的习惯●防止新接触php的人一次次的犯同样的错误●在一致的环境下，人们可以减少犯错的机会1.2. 适用范围适用于本公司的所有开发人员，包括数据库、网页及应用程序开发人员，及有关的程序测试人员。
1.3. 引用标准GB/T 8566-1995 信息技术软件生存期过程GB/T 8567-1988 计算机软件产品开发文件编写指南1.4. 术语GB/T 11457-1995中所使用的术语适用于本规范。
2. 代码编写规则2.1. 注释（1）编写代码期间注释要求占程序总量15%以上。
（2）每个模块顶部必须说明模块名称、功能描述、作者等。
（3）每个过程、函数、方法等开头部分必须说明功能、参数、返回值、原数据和目标数据数据结构等等。
（4）变量定义的行末应当对变量给出注释。
（5）程序在实现关键算法的地方应当给出注释2.2. 变量、函数、过程、控件等命名规则（1）变量命名采用[作用范围][数据类型][自定义名称]规则定义，要求看到变量名就能直观的看出其范围和数据类型。
（2）函数、过程、方法、事件等命名应尽量做到观其名知其义。
（3）控件的命名采用[控件类型][自定义名]规则定义,要求通过名字能直观看出控件类型。
（4）自定义命名空间规则，要求能顾名思义2.3. 源代码规则风格约定：采用缩进的格式保存程序的层次结构。
要求能直观的看出循环、判断等层次结构。
2.4. 用户界面规范（1）用户界面布局和结构应当合理。
（2）颜色搭配方面应当咨询美术专业人员。
（3）界面中必须有产品标识，如果在用户许可情况下可加入公司标识。
2.5. 合理性原则（1）提示说明应当简短且避免产生歧义。
（2）提示或警告信息应当具有向导性，能准确告诉用户错误原因及恢复方法。
提示和警告对话框应当使用标准规范。
（3）快捷键的定义必须符合用户操作习惯（4）程序需要长时间处理或等待时，应当显示进度条并提示用户等待。
（5）一些敏感操作，如删除等操作在执行前必须提示用户确认。
3. 命名规则一般原则：命名要与其自然想适合，根据名字能推导出其含义，一般人的推想也能在意料之中。
3.1. 目录和文件的命名原则：通过名称就能理解目录或文件的意义。
规则：（1）目录命名使用英文小写字母，长度不超过20个字符；（2）文件命名用小写的英文字母、数字和下划线的组合；（3）文件名称使用“性质_描述”的规则，描述可以有多个单词，用”_”隔开，性质一般是该页面得概要。
如register_form.php；（4）凡是类文件使用“模块名_controller.php”的形式，如admin_controller.php。
3.2. 类（class）命名原则：通过类名就能想起这个类是什么。
规则：（1）词的首字母大写，其它字母一概小写；（2）多个词组成的混合名，使用大写字母作为词的分隔，其它字母小写，用以真正传送信息；（3）不要使用下划线“_”；（4）缩写词不要全部使用大写字母。
如使用GetHtmlStatistic，而不用GetHTMLStatistic；（5）派生类的命名与父类无关，只与自身有关。
3.3. 函数和方法命名原则：通常每个函数和方法都是执行一个动作，所以其命名要清楚地说明它们是做什么的。
规则：（1）采用“动作_动作对象”或者简单的就直接使用“动作”的形式.（2）例子形式1：get_table_name()形式2：add()3.4. 类属性命名规则：（1）所有字母都使用小写；（2）使用“_”作为每个词的分界；（3）例如：$associations$many_to_many_sql3.5. 方法中参数命名规则：采用和类属性命名相同的命名规则；3.6. 变量命名规则：（1）所有字母都使用小写；（2）使用“_”作为每个词的分界；（3）如$error，$time_of_error；（4）临时变量的取名应加上前缀tmp，如tmp_user_ame；（5）对象变量的取名应加上前缀obj_作为前缀，如：obj_user;（6）数组变量的取名应加上前缀arr，如arr_book_name；（7）数组下标的变量类型可以是整型和字符串型两种；1．若为整形，数组下标不要用双引号包含；2．若为字符串型，必须用双引号包含。
3.7. 其它（1）用变量和函数返回引用时,引用必须带‘r’前缀（2）全局变量应该带前缀“g”（3）定义命名/全局常量时, 全局常量所有字母大写，用“_”分隔每个单词，如：define (“A_GLOBAL_CONSTANT” , ”hello world”)（4）静态变量应该带前缀“s”，如：static $sStatus = 0;4. 书写规则4.1. IF ELSE语句[布局]if (条件1) { //注释}else if (条件2) { //注释}else { //注释}如果有用else if语句，要有一个else块以用于处理未处理到的其他情况，可以的话放一个记录信息注释在else处，即使else没有任何的动作。
[条件格式]总是将恒量放在等号/不等号的左边，如：if (6==$errorNum) …4.2. SWITCH格式（1）一个case块处理后，直接转到下一个case块处理，在这个case块的最后应该加上注释；（2）default case总应该存在，它应该不被到达，然而如果到达了就会触发一个错误；（3）如果要创立一个变量，那就把所有的代码放在块中。
4.3. Continue，Break和？：的使用（1）不鼓励使用Continue和Break；（2）？：把条件放在括号内以使它和其它的代码相分离；动作尽可能用简单的函数；把所做动作，“？”，“：”放在不同的行。
4.4. 布尔逻辑类型大部分函数在FALSE的时候返回0，但是返回非0值就代表TRUE，因而不要用1（TRUE，YES，诸如此类）等式检测一个布尔值，应该用0（FALSE，NO，诸如此类）的不等式来代替：if (TRUE == func()) { ...应该写成：if (FALSE != func()) { ...4.5. 大括号{}规则将大括号放置在关键词同一行，距前面字符一个空格：if ($condition) {}4.6. 缩进/ 制表符/ 空格规则（1）缩进采用键盘Tab键，不采用空格键。
并且”＝”或者链接字符串时需要左右空一格，每层次缩进长度为4个半角空格；（2）缩进层次大于四或五级，可考虑将代码因数分解（factoring out code）。
4.7. 小括号/ 关键词/ 函数规则（3）不要把小括号和关键词紧贴在一起，要用空格隔开；（4）小括号和函数名紧贴在一起；（5）除非必要，不要在return返回语句中使用小括号。
（6）永远不要在括号与括号之间的字符中间留下空格；（7）永远不要在一个语句中使用不必要的括号，括号只应在源代码中需要的地方使用；（8）不要把小括号和关键词紧贴在一起，要用空格隔开；（9）要把小括号和函数名紧贴在一起，以免跟关键字相混；4.8. php文件扩展名（10）所有浏览者可见页面使用“.htm”；（11）所有类、函数库文件使用“.php”4.9. 不要不可思议的数字用define()来给想表示某样东西的数值一个真正的名字，而不是采用赤裸裸的数字，如：define (“PRESIDENT_WENT_CRAZY” , ”22”);define (“WE_GOOFED” , “19”);4.10. 关于$_GET等变量的调用规则（1）所有GET、POST、SESSION、COOKIE、SERVER等变量均不能直接调用；（2）GET变量ss要使用$_GET[“ss”]调用；（3）POST变量ss要使用$_ POST [“ss”]调用；（4）COOKIE变量ss要使用$_ COOKIE [“ss”]调用；（5）SESSION变量ss要使用$_SESSION [“ss”]调用；（6）SERVER变量ss要使用$_SERVER [“ss”]调用；4.11. 其它（1）别在对象架构期做实际的工作（2）记录所有空语句（3）不要采用缺省方法测试非零值（4）通常避免采用嵌入式的赋值（5）每行一个语句（6）短方法，方法代码要限制在一页内4.12. 代码编辑器（1）需统一使用风格类似的编辑器（2）建议使用Zend Studio5. 书写注释一般原则：1、程序中的注释应该能够被PHPDocument工具转换。
2、鼓励使用非文档注释。
一般性规则是对于那些容易忘记作用的代码添加简短的介绍性注释。
3、使用 C 样式的注释（/* */）和标准 C++ 注释（//)，而不使用 Perl/shell 样式的注释（#）。
5.1. 文件头注释在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；修改历史；生成日期；模块功能描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等）；主要函数或过程清单及本文件历史修改记录等。
注释方法：/*** 简述**（详细的功能描述）** @author* @version* @history*/5.2. 函数头注释在每个函数或过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等。
注释方法：根据实际情况采用单行注释（//）或多行注释（/* */）。
5.3. 行注释在以下地方需要加上注释：（1）代码中重要部分或难度较大部分加注释；（2）在if、else语句中具有暗示意味、有重要意义的条件旁加注释；（3）当循环语句中的终止条件不太清晰时加注释；（4）代码复杂部分加注释；（5）容易引起混乱的变量加注释。
（6）需要添加但未实现的代码模块；注释方法：（1）// 注释一行（2）//// 四个斜杠代表当前有未实现的内容，相当于占位符（3）/* …… */ 注释若干行（4）注释简单明了，含义准确，防止注释二义性。
保持注释与其描述的代码相邻，即注释的就近原则；（5）边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性；（6）变量、常量的注释应放在其上方相邻位置或右方；（7）全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时的注意事项等；5.4. 其它（1）PHP脚本标记采用 <?php … ?>，只输出变量时用 <?php echo $username; ?>；（2）无论在什么地方无条件包含一个类型文件，应该使用 require_once()；有条件的包含一个类型文件，应该使用 include_once()。