PHP编码规范 [复制链接]

PHP编码规范-文件结构
|
|――images
|――include
　　|――parameter
　　|――config
　　|――function
|――index

images存放图片文件，include中是系统是要引用的文件，一般在parameter中存放参数文件，config中存放配置文件，function中存放方法文件，如javascript的方法等，并按功能模块的分类，将各功能的类也放入其中

/*
　* @(#)Cngift.php 1.82 03/06/25
　*
　* 开花石头编写的示例文档
　* 将对编码规范做简单的示范
　*
　*/


require( “db.php” );

/**
　* 示范用类
　*
　* @version 1.82 03.06.25
　* @author 开花石头
　*/
class Blah extends SomeClass {
　　/* 这个类运行时的注释写在这里 */

　　/** 关于变量的注释写在这里 */
　　static int $classVar1;

　　/**
　　　* 对变量编写的多行注释写在这里
　　　*/
　　static string classVar2;

　　/** 变量的文档注释 */
　　int instanceVar1;

　　/** 变量的文档注释 */
　　int[] instanceVar3;

　　/**
　　　* 构造函数的注释
　　　*/
　　function Blah() {
　　　　// ...在这里执行...
　　}

　　/**
　　　* ...函数的文档注释...
　　　*/
　　function doSomething() {
　　　　// ...在这里执行...
　　}

　　/**
　　　* ...方法的注释文档..
　　　* 多行注释
　　　*/
　　public void doSomethingElse(Object someParam) {
　　　　// ...在这里执行...
　　}
}

命名空间
一个唯一命名空间的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org，或1981年ISO 3166标准所指定的标识国家的英文双字符代码。命名空间的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department)，项目(project)，机器(machine)，或注册名(login names)，也可以按功能模块来分类。

空行
空行将逻辑相关的代码段分隔开，以提高可读性。

下列情况应该总是使用两个空行：
- 一个源文件的两个片段(section)之间
- 类声明声明之间

下列情况应该总是使用一个空行：
- 两个方法之间
- 方法内的局部变量和方法的第一条语句之间
- 块注释或单行注释之前
- 一个方法内的两个逻辑段之间，用以提高可读性

所有的源文件都应该在开头有一个C语言风格的注释，其中列出类名、功能、版本信息、日期、作者和版权声明：


/*
　* 类名
　* 功能
　* 版本
　* 日期
　* 作者
　* 版权
　*/

如果对文件进行了修改，应该在文件头中说明修改目的、修改日期、修改人，并变更文件的版本信息；如果修改问文件的一部分，则在文件中进行注释即可，并且标识出修改部分的起止位置

……

/*
　* 修改目的
　* 修改日期
　* 修改人
　* 版本
　*/

……

修改起始

……

……

修改结束

……

块注释
块注释通常用于提供对文件，方法，数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方，比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。

块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：


/*
　* 这里是块注释
*/


块注释可以以/*-开头，这样indent(1)就可以将之识别为一个代码块的开始，而不会重排它。


/*-
　* 如果想被忽略，可是使用特别格式的块注释
　*
　* one
　* 　　two
　* 　　　　three
　*/


注意：如果你不使用indent(1)，就不必在代码中使用/*-，或为他人可能对你的代码运行indent(1)作让步。

文件夹命名一般采用英文，长度一般不超过20个字符，命名采用小写字母。除特殊情况才使用中文拼音，一些常见的文件夹命名如：images(存放图形文件)，flash（存放Flash文件），style(存放CSS文件)，scripts（存放Javascript脚本），inc(存放include文件)，link（存放友情链接）,media(存放多媒体文件)等。文件名称统一用小写的英文字母、数字和下划线的组合。