PHP编码规范

作者: harde 分类: PHP 发布时间: 2010-01-03 20:08

编码规范有什么用这个问题我想就不用提了吧……
本文分两部分
第一部分简单说下HTML的书写规范

第二部分是PHP的编码规范
不愿意看第一部分的
可以点击我直接跳到PHP编码规范

html

1、标签、属性全部小写、标签必须闭合
2、除同一标签的闭合标签,尽量不要写在一行,换行时注意缩进
例:一个table

<table>
    <tr>
        <td>我是内容</td>
    </tr>
</table>


3、正确的标签嵌套
例:

<div>
    <p>我是内容</div>
</p>

是不允许的

4、属性值需用半角双引号引起,若因嵌套原因则也应适用半角单引号引起

<table border="1">
    <tr>
        <td colspan="2">我是内容</td>
    </tr>
</table>

5、有良好的注释习惯

<!--头部广告-->
<table border="1">
    <tr>
        <td colspan="2">我是广告</td>
    </tr>
</table>

PHP编码规范

1、代码标记
PHP可以使用

<?php ?>
<? ?>

等四种方式嵌入php代码,但除了第一种,其他或多或少被限制,所以如果不是特殊原因,尽量使用

<?php ?>

2、注释规则
注释必不可少,但是也不可过多,决不可为写注释而写注释
块注释

/*
    常用于提供对文件、方法、数据结构和算法的描述。
    书写时要注意和它所描述的代码具有相同缩进
*/

单行注释

if (false)
{
    /* 没有特殊要求 */
    echo "一样注意缩进,\r\n如果需要换行,则需要使用块注释"; 
}

尾端注释

if (false)
{ 
    echo "没有特殊要求"; /* 注意缩进,建议不适用,因为不容易区分代码与注释 */
}

行末注释
<pre lang="php" collapse="true">
if (false)
{ 
    echo "没有特殊要求"; //注释界定符,很方便,尤其从学过JAVA与C#语言的人,可能更热衷此种注释
}

PHP书写规则

1、缩进
没有硬性要求,但通常为4个半角空格
2、大括号
两种使用
一种紧接行尾
一种换行使用
没有固定要求,依照个人习惯使用,通常为第二种

function a(){

}

function b()
{

}

3、关键字、小括号、行数、运算符
不要把小括号与关键字紧挨在一起

if ($false)//if 与 (之间有一个空格
{

}

小括号要紧挨函数,以便区分关键字与函数

round($num);//round 与 (之间没有空格

运算符两边要有一个空格

if($a == $b)

当代码段较大时、上下应加入空白行、两代码块之间使用一个空白行、禁止多个空白行

尽量不要在return后使用小括号

PHP命名规则

1、类命名
遵循帕斯卡命名法
注意不要使用下划线
如ClassInfo
UserInfo

2、类属性命名
参考匈牙利命名法
以m为前缀,后面每个单词首字母大写
如mValue
mName

3、方法命名
注意前缀与后缀
与类一样,遵循帕斯卡命名法
如IsExistUser()
GetUserName()
SetUserName()

4、方法中参数命名
遵循骆驼命名法
首字母小写,后每个单词首字母大写

IsExistUser($userId)
GetUser($userName)

5、变量命名
所有字母均小写
使用_作为单词分割

$msg_error
$user_name
注意引用变量应有r前缀
如$rExam
全局变量需带g前缀
如$gPath
静态变量需有s前缀
$sPath
常量与全局常量需要全部使用大写字母单词间以_分割

define(‘PAGE_SIZE’,90);
define(‘PAGE_NUM’,1);

6、函数命名
全部使用小写。单词间以_分割

function goog_idea()
{

}

7、前缀可以嵌套(匈牙利命名法
如$msValue;//静态的成员变量

如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!

2条评论
  • 朱二

    2010-04-03 上午 9:45

    兄弟,交换下链接如何?

    1. harde

      2010-04-05 下午 12:05

      貌似咱们不是一个类型的Blog…

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注