php 代码编写规范 (4)

4.2.9 true/false和0/1判断
遵循以下规则:
a. 不能使用0/1代替true/false,在PHP中,这是不相等的;
b. 不要使用非零的表达式、变量或者方法直接进行true/false判断,而必须使用严格的完整true/false判断;
如:不使用if ($a) 或者if (checka()) 而使用if (FALSE != $a)或者 if (FALSE != check())

4.2.10 避免嵌入式赋值
在程序中避免下面例子中的嵌入式赋值:
不使用这样的方式:
while ($a != ($c = getchar()))
{
process the character
}

4.2.11 错误返回检测规则
检查所有的系统调用的错误信息,除非你要忽略错误。
为每条系统错误消息定义好系统错误文本,并记录错误LOG。

4.3 程序注释
每个程序均必须提供必要的注释,书写注释要求规范,参照PEAR提供的注释要求,为今后利用phpdoc生成php文档做准备。程序注释的原则如下:
a. 注释中除了文件头的注释块外,其他地方都不使用//注释,而使用/* */的注释;
b. 注释内容必须写在被注释对象的前面,不写在一行或者后面;

4.3.1 程序头注释块
每个程序头部必须有统一的注释块,规则如下:
a. 必须包含本程序的描述;
b. 必须包含作者;
c. 必须包含书写日期;
d. 必须包含版本信息;
e. 必须包含项目名称;
f. 必须包含文件的名称;
g. 重要的使用说明,如类的调用方法、注意事项等;
参考例子如下:

<?php

//

// +———————————————————+

// | PHP version 4.0                                         |

// +———————————————————+

// | Copyright (c) 1997-2001 The PHP Group                   |

// +———————————————————+

// | This source file is subject to  of the PHP license,     |

// | that is bundled with this packafile LICENSE, and is     |

// | available at through the world-web at                   |

// |                     |

// | If you did not receive a copy of the  and are unable to |

// | obtain it through the world-wide-web,end a note to      |

// | license@php.net so we can mail you a immediately.       |

// +———————————————————+

// | Authors: Stig Bakken <ssb@fast.no>                      |

// |          Tomas V.V.Cox <cox@idecnet.com>                |

// |                                                         |

// +———————————————————+

//

// $Id: Common.php,v 1.8.2.3 2001/11/13 01:26:48 ssb Exp $

4.3.2 类的注释
类的注释采用里面的参考例子方式:

/**

* @ Purpose:

* 访问数据库的类,以ODBC作为通用访问接口

* @Package Name: Database

* @Author: Forrest Gump gump@crtvu.edu.cn

* @Modifications:

* No20020523-100:

* odbc_fetch_into()参数位置第二和第三个位置调换

* John Johnson John@crtvu.edu.cn

* @See: (参照)

*/

class Database

{

……

}

4.3.3 函数和方法的注释
函数和方法的注释写在函数和方法的前面,采用类似下面例子的规则:

/**

* @Purpose:

* 执行一次查询

* @Method Name: Query()

*

* @Param: string $queryStr SQL查询字符串

* @Param: string $username 用户名

*

* @Author: Michael Lee

*

* @Return: mixed 查询返回值(结果集对象)

*/

function($queryStr,$username

{……}

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zzsddf.html