兄弟连就业期学员项目windfire.pdfVIP

爱户外小组编码规范

文件状态：文件标识：编码规范

[√]草稿当前版本：1.0

[]正式发布作者：windFire小组

[]正在修改完成日期：2014-2-26

规范目标

能够遵守公共一致的编码标准对任何开发项目都很重要，特别是在多人的开发团队中，

编码标准能帮助确保代码的质量、减少Bug和容易。目标如下：

新人可以很快的适应环境，方便的融入到项目团队中

在一致的环境下，团队协作中有更高的效率，团队的成员可以减少犯错的机会

程序员可以方便的了解其他人的代码，弄清程序的状况，就和看自已的代码一样

防止接触PHP的新人自创一套风格并养成终生的习惯，一次次的犯同样的错误

开发工具——Zendstudio

一个项目团队尽量要使用统一的开发工具，并且要统一版本

APHP的文件格式

APHP开始和结束标记

当中带有PHP代码，使用?php?标记来界定PHP代码，在HTML页面中嵌入

纯变量时，还可以使用?=$variablename?这样的形式。

对于只包含有PHP代码的文件，结束标志（?）是不允许存在的，PHP自身不需要

（?）。这样做,可以防止它的末尾被意外地注入，从而导致像使用Header()、set()

和session_start()等设置头信息的函数时发生失败。

注释规范

注释是对于那些容易忘记作用的代码添加简短的介绍性内容，可以在PHP中使用

以“/**”开始和以“*/”作为结束的多行文档注释、还有普通多行注释“/**/”，以及单行

注释符号“//”。所有文档块建议和phpDocumentor格式兼容。PHPDocumentor是一个用PHP

写的工具，对于有规范注释的php程序，它能够快速生成具有相互参照,索引等功能的API

文档。可以通过在客户端浏览器上操作生成文档，文档可以转换为PDF,HTML,CHM几种形

式，非常的方便。PHPDocument是从你的源代码的注释中生成文档，因此在给你的程序做

注释的过程，也就是你编制文档的过程。从这一点上讲，PHPDocumentor促使你要养成良好

的编程习惯，尽量使用规范，清晰文字为你的程序做注释，同时多少也避免了事后编制文档

和文档的更新不同步的一些问题。在PHPDocumentor中，注释分为文注释和非文

注释。所谓文注释，是那些放在特定关键字前面的多行注释，特定关键字是指能够被

PHPDocumentor分析的关键字，例如class，var等。那些没有在关键字前面或者不规范的

注释就称作非文注释，这些注释将不会被PHPDocumentor所分析，也不会出现在你产

生的api文档中。

文件顶部的注释

所有的文档注释都是由/**开始的一个多行注释，在phpDocumentor里称为DocBlock,

DocBlock是指软件开发人员编写的关于某个关键字的帮助信息，使得其他人能够通过它知

道这个关键字的具体用途，如何使用。PhpDocumentor规定一个DocBlock包含：功能简述

区；详细说明区；标记tag，每个包含PHP代码的文件必须至少在文件顶部的DocBlock

包含这些phpDocumentor。另外每一个程序文件头部中，应放入相应CVS控制字串，

以方