BIWEB PHP 编码规则

《BIWEB PHP 编码规则》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、BIWEBPHP编码规则(讨论组：Arthur)2005-6-29制定2009-12-28调整目录BIWEBPHP编码规则1目标2内容：2一．命名规则2二．目录结构2三．文件33.1文件编码33.2文件名33.3文件头4四．函数64.1函数名64.2函数头6五.常量6六．变量6七.排版77.1养成缩排习惯77.2{}编码规则7八．注意单引号和双引号的区别，尽量多使用单引号双引号内可以直接写变量7九.数据编码7十.输入输出值检查8十一.SQL语句8十二.字符集设置charset=UTF-88十三．空行的使用

2、8十四．Smarty8十五.模板的结构9十六.模板的规则911目标如果您已经决定向BIWEB贡献代码，请详细阅读以下规范，并严格遵守。这样在保证您代码可读性的同时还可以大大减少我们的工作量。内容：一．命名规则目录、文件、函数、变量的命名要以英文进行命名，不使用汉字，名称要有意义，更要容易理解，其中目录名、文件名都采用小写字母，这样在linux下不会产生因为大小写而出现找不到链接的错误；而函数名的首字母要大写；变量命名由多个单词组成的时候，每个单词首字母大写，对于变量名的前面要加小写变量类型前缀，前缀后面的

3、首字母大写。变量类型前缀参看第5点变量命令规则。二．目录结构按照功能设置目录，并根据目录的层级可以了解各功能的相互关系。网站总体架构说明 整站配置文件目录11 新闻栏目目录 新闻栏目配置文件目录 新闻栏目后台管理目录三．文件3.1文件编码请调整您的编辑器文件编码为**UTF-8**，并**关闭UTF-8BOM**的功能。请不要使用windows自带的记事本编辑项目文件。3.2文件名11类文件：类名称.class.php例如：database.class.php调用mysql类文件webservice.cl

4、ass.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非公共函数文件包含文件：

5、该文件非独立使用，被其他程序所包含的文件。文件名.inc.php3.3文件头每个文件都需要写文件头fileheader:(Sample)

6、@copyrightJimmyBoyInc*@version1.0*@paramnumeric$temptemperature*@paramstring$scalescaletoconvertto;mustbeeitherCorF*@returnnumeric$newTempconvertedtemperature*//***newtemperaturevalueafterconversion**@accessprivate*@varnumeric*/functionconvertTemp($temp,$

7、scale){var$newTemp;11if($scale=='F'){$newTemp=((9/5)*$temp)+32;}else{$newTemp=(5/9)*($temp-32);}return$newTemp;}?>註解是遵循PhpDocumentor的規則，PhpDocumentor标记的基本元素名为DocBlock，即一个多行注解块，它可以出现在任何PHPconstruct，类，或者函数之前，如下所示：/** *texthere * */在这一DocBlock之中，PhpDocumento

8、r接收三种类型的选项：一个简短描述，一个比较长的描述，以及一系列以@符号前缀的特定标签，如表C所示。这些标签为可选择性，然而它能够使最终文档变得更加精确。以下为PhpDocumentor支持的常用标签：@access:函数为私有或为公共@author:函数作者的名字和邮箱地址@version:函数的版本数@copyright:函数的版权(如果需要)@package:函数从属的封装包@param:函数变量，包括类型及其描述@re