首页
开发手册
应用中心
工具
用户中心
FoundPHP 开发命名规范
中文简体
中文简体
English
上一篇
下一篇
### FoundPHP 开发命名规范 FoundPHP 开发与传统的PHP相同,作者考虑到开发中的规则与php传统相似度,提出以下规范,建议遵守此规范对于开发会更加方便。 这里讲述命名方式为:变量、函数、类。 #### 1. 变量命名 - 变量全部采用小写单词组成,可以简写。如:$us、$img、$ary等。 - 使用'_'作为每个词的分界。如:$msg_error、$us_pwd等。 - 临时变量通常被取名为`i,j,k,m和n`,它们一般用于整型。 ------------
#### 2. 函数命名 - 函数命名全部采用小写单词或拼音多个单词使用_作为分界符。如:font_cut()、user_check()等。 - 函数编写必须编写注释,建议采用 `/* 注释内容 */`这样可以多行注释说明函数使用方法。 - 函数值小于等于3组参数直接赋值,避免因未赋值导致报错。 ```PHP /* user_id 用户id user_name 用户名字 user_age 用户年龄 */ function user_info($user_id=0,$user_name='',$user_age=18){ //处理内容 echo $user_id.',名字: '.$user_name.' 年龄: '.$user_age; } //使用方法 user_info(1,'tonsen',22); ``` - 比较复杂的函数需要处理多种数据,但又不固定的数据处理时则可以采用数组形式。 ```PHP /* ary user_id 用户id user_name 用户名字 user_age 用户年龄 */ function user_info($ary=array()){ //处理内容 echo $ary['user_id'].',名字: '.$ary['user_name'].' 年龄: '.$ary['user_age']; } //使用方法 user_info(array( 'user_id' =>1, 'user_name' =>'tonsen', 'user_age' =>22, )); ``` ------------
#### 3. 类/方法命名 - 使用大小写字母单词或拼音多个单词使用_作为分界符。如:FoundPHP_img、FoundPHP_user等。 - 类属性命名与变量用法相同 ```PHP class FoundPHP_img{ var $img_width = 88; //类属性 var $img_height = 88; //类属性 } ``` - 类方法命名与函数命名相同 ```PHP class FoundPHP_img{ /* max_width 最大宽度值 */ function set_width($max_width=300){ //方法处理 } } ``` ------------ FoundPHP采用比较统一的命名规则,方便开发用户降低学习成本,同时提高了代码阅读性。 开发过程中中国用户尽量多用英文单词,请避免使用拼音或拼音简写命名。