单行注释用//多行注释用/* */组合。推荐使用//注释(因为/* */不允许嵌套使用,而//可以)。
文件修改的注释:如果文件修改了在文件的说明后面加上这些东西
///////////////////////////////////////////////////////////////////////
// 修改日期: :2011/10/1
// 修改人: :(by 作者)
// 版本号: :1.0.02
// 修改目的 :
/*
说明目的(例如:添加几个新的方法)
*/
///////////////////////////////////////////////////////////////////////
最后在修改的地方标上其实修改和结束修改的标志。格式为:
//modify start + 版本号(by 作者)
…(源代码)
//modify end + 版本号(by 作者)
关于引入语句的注释:
//数据库类操作
requireonce(“./class/Db.php”);
要注意的几点:
a): 推荐使用requireonce
b): 所有的requireonce都放在最前面。文件信息之后。
参考源代码范例
////////////////////////////////////////////////////
//文件名称: CPoint.php
//创建日期: 2007/02/01
//功能说明: 关于点的操作的类
//作 者: (by 作者)
//版本号: 1.0.0.1
////////////////////////////////////////////////////
////////////////////////////////////////////////////
// 修改日期: :2007/03/01
// 修改人: :(by 作者)
// 版本号: :1.0.02
// 修改目的
/*
添加了PrintPoint方法
*/
////////////////////////////////////////////////////
// 版本号 + modify start (by 作者)
// 版本号 + modify end(by 作者)
requireonce("./math.php");
namespace Math
{
class CPoint extends CObject
{
//构造函数 (最好把构造函数和析构函数放在最前面
public function _constructor($nx, $ny)
{
$x = $nx;
$y = $ny;
}
//析构函数
public function _destructor()
{
}
//1.0.0.2 modefy start(by andylin)
///////////////////////////////////////////////////////////////////////
// 函数名 : PrintPoint
// 功能描述 : 打印Point的x,y
// 参数 : 如果n == 1 print x 如果 n == 2 print y 否则print x, y
// 返回值 : 无
///////////////////////////////////////////////////////////////////////
//类似上面的声明,如果函数复杂应该要写,否者可以不写。比如下面的几个函数很简单就可以不写
public function PrintPoint($n)
{
if ($n == 1)
{
echo "x = ", x;
}
else if ($n == 2)
{
echo "y = ", y;
}
else
{
echo "x = ", x;
echo "y = ", y;
}
}
//1.0.0.2 modefy end(by andylin)
public function SetX($nx)
{
$this->x = $nx;
}
public function SetY($ny)
{
$this->y = $ny;
}
public function GetX()
{
return $this->x;
}
public function GetY()
{
return $this->y;
}
//Data Session
private $x = 0; //特殊的如i, j, k, x, y, n之类的可以不按命名规则。
private $y = 0 //否者,应当遵循。
};
};
- 第一章 编辑器设置
- 1.1.使用Tab缩进,不要使用空格
- 第二章 命名规范
- 2.1.变量名
- 2.2.类的方法命名
- 2.3.函数命名
- 2.3.1.控制器命名
- 2.3.2.方法体命名
- 2.3.3.视图层层级关系
- 2.4.函数自变量
- 2.5.文件命名
- 第三章 代码规范
- 3.1.使用大括号
- 3.2.大括号的位置
- 3.3.数组格式
- 3.4.在运算符之间使用空格
- 3.5.运算符优先级
- 3.6.条件语句
- 第四章 SQL语句规范
- 4.1.SQL代码层
- 4.2.MySQL的查询性能优化原则
- 4.3.SQL语句汇总
- 第五章 HTML代码规范
- 5.1.XHTML标准
- 5.2.可视化元素分离
- 第六章 通用规范
- 6.1.引号
- 6.2.关联数组
- 6.3.注释
- 6.4.类型比较
- 6.5.递增/递减运算符
- 6.6.三元条件运算符
- 6.7.未初始化的变量
- 6.8.变量/数组是否为空的检测
- 6.9.字符串的大小写转换
- 6.10.检查字符串长度
- 6.11.PHP标签
- 6.12.程序文件末尾
- 6.13.magic_quotes_gpc
- 6.14.包含文件
- 6.15.遍历数组
- 6.16.避免修改for循环内的条件值
- 6.18.时间问题
- 6.19.注释