内容简介:PHP标记编码规范代码注释常量变量数据类型运算符表达式和语句1.PHP标记
PHP 与其他几种 Web 语言一样,使用一对标签将 PHP 代码部分括起来,以将其与 html 代码区分开来。 解析文件时,PHP 会查找开始标签和结束标签; 也就是说,它们告诉 PHP 开始和停止解析之间的代码。 这种解析方法允许PHP嵌入到各种文档中,除了开始和结束标记之外的任何部分都将被PHP解析器忽略。
PHP中有四种标记样式,其中脚本样式和ASP样式在PHP 7中已被废除。短样式需要打开php.ini中的开关或使用CLI中的配置选项--short-tags。
1.1 XML
<?php
echo "这是XML风格的标记";
?>
XML 样式标记是本书中使用的标记,是推荐的标记,并且不能被服务器禁用。 这种标记样式可以在 XML 和 XHTML 中使用。
1.2 短款
<? echo '这是简短风格的标记'; ?>
1.3 脚本风格
<script language="php">
echo '这是脚本风格的标记';
script>
1.4 ASP风格
<%
echo '这是ASP风格的标记';
%>
1.5 注意事项
如果文件内容是纯PHP代码,最好删除文件末尾的PHP结束标记。 这可以防止PHP不小心在PHP结束标记后面添加空格或换行符,从而导致PHP开始输出这些空格,而此时在脚本中并没有打算输出它们。
<?php
echo "Hello world";
echo "Last statement";
// 脚本至此结束,并无 PHP 结束标记
2. 编码标准 2.1 编写标准
[1]。 缩进采用制表符(键)缩进,缩进单位为4个空格。 编辑器中,制表符统一设置为转换为4个空格。 [2]。 大括号 {} 有两种大括号放置规则可用:
if ($expr)
{
…
}
或者
if ($expr){
…
}
[3].关键字、括号、函数、运算符
if ($expr){ //if和“(”之间有一个空格
…
}
round($num) //round和“(”之间没有空格
while ($boo == true){ //$boo和“==”,true和“==”之间都有一个空格
…
}
return 1; //除非是必要,否则不需要使用小括号
2.2 命名规则
[1].类命名
[2]。 类属性命名
[3].方法命名
方法的功能是执行一个动作并实现一个目标。 所以名称应该解释该方法的作用。 一般名称的前缀和后缀都有一定的规则,如:Is(判断)、Get(获取)、Set(设置)。 方法的命名约定与类的命名一致。 喜欢:
class Example{
$mExam = "";
function SetExam(&$rExam){
…
}
function &rGetExam(){
…
}
}
[4].方法中参数的命名
class EchoAnyWord{
function EchoWord($firstWord,$secondWord){
…
}
}
[5].变量命名
$msg_error;
$chk_pwd;
[6]. 引用变量 引用变量必须以“r”为前缀。 喜欢:
class Example{
$mExam = "";
function SetExam(&$rExam){
…
}
function &rGetExam(){
…
}
}
[7]. 全局变量 全局变量应以“g”为前缀。 喜欢:
$global = $gTest;$global = $g
[8]。 常量/全局常量 常量/全局常量应全部用大写字母书写,单词之间用“_'”分隔。 喜欢:
define('DEFAULT_NUM_AVE',90);
define('DEFAULT_NUM_SUM',500);
[9]。 静态变量 静态变量应以“s”为前缀。 喜欢:
static $sStatus = 1;
[10]. 所有函数名均使用小写字母,多个单词之间用“__”分隔。 喜欢:
function this_good_idea(){
…
}
[11]。 上述命名规则可以组合使用。 喜欢:
class OtherExample{
$msValue = ""; //该参数既是类属性,又是静态变量
}
3. 代码注释
注释是对代码的解释和说明,通常放在代码上方或代码末尾。 用于描述代码或函数的作者、作用、时间等。 PHP 支持 3 种风格的程序注释。 C++ 风格的单行注释 (//)
<?php
echo '使用C++风格'; //这就是C++风格
?>
C 风格多行注释 (/*...*/)
<?php
/*C风格的
多行注释
*/
echo '只会看到这句话';
?>
注意:不允许嵌套多行注释。 Shell 风格的注释 (#)
<?php
echo '这是Shell脚本风格的注释'; #这里的内容是看不到的
?>
注意:不要在单行注释中使用“?>”标记。 解释器会认为PHP脚本已经结束并执行“?>”后面的代码