php編碼規范：文檔注釋幾種方法

本文章提供了5種注釋方法：塊注釋，單行注釋，尾端注釋，行末注釋，文檔注釋哦，下面我們就一一來看看吧。

短注釋可以顯示在一行內，並與其後的代碼具有一樣的縮進層級。如果一個注釋不能在一行內寫完，就該采用塊注釋。單行注釋之前應該有一個空行。以下是一個代碼中單行注釋的例子：

if (condition) {

　　/* 以下代碼運行的條件 */
　　...
}

尾端注釋

if ($a == 2) {
　　return TRUE; /* 對單一條件的說明 */
} else {
　　return isPrime($a); /* 其余的條件 */
}

/*
　* 這裡是塊注釋
*/

塊注釋可以以/*-開頭，這樣indent(1)就可以將之識別為一個代碼塊的開始，而不會重排它。

/*-
　* 如果想被忽略，可是使用特別格式的塊注釋
　*
　* one
　* 　　two
　* 　　　　three
　*/

注意：如果你不使用indent(1)，就不必在代碼中使用/*-，或為他人可能對你的代碼運行indent(1)作讓步。

4.4 行末注釋

注釋界定符"//"，可以注釋掉整行或者一行中的一部分。它一般不用於連續多行的注釋文本；然而，它可以用來注釋掉連續多行的代碼段。以下是所有三種風格的例子：

if ($foo > 1) {

　　// 第二種用法.
　　...
}
else {
　　return false; // 說明返回值的原因
}

//if ($bar > 1) {
//
// 　// 第三種用法
//　 ...
//}
//else {
　　// return false;
//}

檔注釋

/**
　* 說明這個類的一些 ...
*/