BIWEB PHP 编码规则 新版.docVIP

BIWEB PHP 编码规则 (讨论组：Arthur) 2005-6-29制定 2009-12-28调整 目录 BIWEB PHP 编码规则 1 目标 2 内容： 2 一．命名规则 2 二．目录结构 2 三．文件 3 3.1文件编码 3 3.2文件名 3 3.3 文件头 4 四．函数 6 4.1 函数名 6 4.2 函数头 6 五. 常量 6 六．变量 6 七. 排版 7 7.1养成缩排习惯 7 7.2 {}编码规则 7 八． 注意单引号和双引号的区别，尽量多使用单引号双引号内可以直接写变量 7 九.数据编码 7 十.输入输出值检查 8 十一.SQL 语句 8 十二.字符集设置charset=UTF-8 8 十三．空行的使用 8 十四．Smarty 8 十五. 模板的结构 9 十六. 模板的规则 9  目标 如果您已经决定向BIWEB贡献代码，请详细阅读以下规范，并严格遵守。这样在保证您代码可读性的同时还可以大大减少我们的工作量。 内容： 一．命名规则 目录、文件、函数、变量的命名要以英文进行命名，不使用汉字，名称要有意义，更要容易理解，其中目录名、文件名都采用小写字母，这样在linux下不会产生因为大小写而出现找不到链接的错误；而函数名的首字母要大写；变量命名由多个单词组成的时候，每个单词首字母大写，对于变量名的前面要加小写变量类型前缀，前缀后面的首字母大写。变量类型前缀参看第5点变量命令规则。 二．目录结构 按照功能设置目录，并根据目录的层级可以了解各功能的相互关系。 网站总体架构说明 ?整站配置文件目录 ?新闻栏目目录 ?新闻栏目配置文件目录 ?新闻栏目后台管理目录 三．文件 3.1文件编码 请调整您的编辑器文件编码为**UTF-8**，并**关闭UTF-8 BOM**的功能。请不要使用windows自带的记事本编辑项目文件。 3.2文件名 类文件：类名称.class.php 例如：database.class.php 调用mysql类文件 webservice.class.php 网站service类文件 smtp.class.php 发送smtp的类文件 注：公共类文件存放在web_common5.8目录中 所有文件以Unicode的方式存储，文件名全部小写 函数文件：××.func.php ××.func.js 注：website_common/php_includes/_common 目录的公共函数文件，前面必须加g，其他目录的函数文件不需加g 例如：gcommon_func.php 公共函数文件 gjs_func.js 公共js文件 input_func.php 非公共函数文件 包含文件：该文件非独立使用，被其他程序所包含的文件。文件名.inc.php 3.3 文件头 每个文件都需要写文件头 file header: (Sample) ?php /** * function to convert temperature from C to F * * This function accepts two arguments, a temperature and a string * which must be either C or F and converts it to the named scale * * @access public * @author Jimmy Boy * @copyright Jimmy Boy Inc * @version 1.0 * @param numeric $temp temperature * @param string $scale scale to convert to; must be either C or F * @return numeric $newTemp converted temperature */ /** * new temperature value after conversion * * @access private * @var numeric */ function convertTemp($temp, $scale) { var $newTemp; if ($scale == F){ $newTemp = ((9/5)*$temp)+32; }else{ $newTemp = (5/9)*($temp-32); } return $newTemp; } ? 註解是遵循PhpDocumentor的規則，PhpDocumentor标记的基本