單行注釋用//多行注釋用/* */組合。推薦使用//注釋(因為/* */不允許嵌套使用,而//可以)。
文件修改的注釋:如果文件修改了在文件的說明后面加上這些東西
?????? ///////////////////////////////////////////////////////////////////////
?????? // 修改日期:?????? ?: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.注釋