PHP標準注釋

「php是一門及其容易入門的語言，剛入門的新手不到幾分鐘的時間可能就會用echo列印出乙個hello world ！但是他是真正的程式設計師嗎？怎麼來定義程式設計師呢？如果想真正成為乙個程式設計師，那麼就必須遵循一套程式書寫規範，」

我們經常編寫一些函式，但是這些函式可能也只有自己能看得懂，甚至過一段時間自己也不認識自己寫的了，那麼怎麼辦呢？最好的辦法當然是給給自己的**加上注釋。

我們可能熟悉很多注釋的寫法c pear php注釋等等，但我們用到的主要還是# 和/**/。

#是一種簡短的注釋方法。可能你會用它去注釋乙個變數，或者呼叫的乙個方法。/**/我們可能還在用它去注釋掉一大段**，但是怎麼用它去標準的注釋乙個函式呢？

/*** @abstract 申明變數/類/方法

* @access 指明這個變數、類、函式/方法的訪問許可權

* @author 函式作者的名字和郵箱位址

注釋的資訊很全面，可能有很多我們用不到，紅色部分是我們經常用到的。

示例：檔案頭部模板

/*

**這是乙個什麼檔案
**此檔案程式用來做什麼的（詳細說明，可選。）。
* @author richard* @version $id$
* @since 1.0
*/

函式頭部注釋

/*

** some_func 
* 函式的含義說明
** @access public
* @param mixed $arg1 引數一的說明
* @param mixed $arg2 引數二的說明
* @param mixed $mixed 這是乙個混合型別
* @since 1.0
* @return array
*/public
function thisisfunction($string, $integer, $mixed)

類的注釋

/*

** 類的介紹
** 類的詳細介紹（可選。）。
* @author richard* @since 1.0
*/class
test 

程式**注釋

1. 注釋的原則是將問題解釋清楚，並不是越多越好。

2. 若干語句作為乙個邏輯**塊，這個塊的注釋可以使用/* */方式。

3. 具體到某乙個語句的注釋，可以使用行尾注釋：//。

/*

生成配置檔案、資料檔案。
*/$this->setconfig();
$this->createconfigfile(); //
建立配置檔案
$this->clearcache(); //
清除快取檔案
$this->createdatafiles(); //
生成資料檔案
$this->prepareproxys();
$this->restart();

「php是一門及其容易入門的語言，剛入門的新手不到幾分鐘的時間可能就會用echo列印出乙個hello world ！但是他是真正的程式設計師嗎？怎麼來定義程式設計師呢？如果想真正成為乙個程式設計師，那麼就必須遵循一套程式書寫規範，」

我們經常編寫一些函式，但是這些函式可能也只有自己能看得懂，甚至過一段時間自己也不認識自己寫的了，那麼怎麼辦呢？最好的辦法當然是給給自己的**加上注釋。

我們可能熟悉很多注釋的寫法c pear php注釋等等，但我們用到的主要還是# 和/**/。

#是一種簡短的注釋方法。可能你會用它去注釋乙個變數，或者呼叫的乙個方法。/**/我們可能還在用它去注釋掉一大段**，但是怎麼用它去標準的注釋乙個函式呢？

/*** @abstract 申明變數/類/方法

* @access 指明這個變數、類、函式/方法的訪問許可權

* @author 函式作者的名字和郵箱位址

注釋的資訊很全面，可能有很多我們用不到，紅色部分是我們經常用到的。

示例：檔案頭部模板

/*

**這是乙個什麼檔案
**此檔案程式用來做什麼的（詳細說明，可選。）。
* @author richard* @version $id$
* @since 1.0
*/

函式頭部注釋

/*

** some_func 
* 函式的含義說明
** @access public
* @param mixed $arg1 引數一的說明
* @param mixed $arg2 引數二的說明
* @param mixed $mixed 這是乙個混合型別
* @since 1.0
* @return array
*/public
function thisisfunction($string, $integer, $mixed)

類的注釋

/*

** 類的介紹
** 類的詳細介紹（可選。）。
* @author richard* @since 1.0
*/class
test 

程式**注釋

1. 注釋的原則是將問題解釋清楚，並不是越多越好。

2. 若干語句作為乙個邏輯**塊，這個塊的注釋可以使用/* */方式。

3. 具體到某乙個語句的注釋，可以使用行尾注釋：//。

/*

生成配置檔案、資料檔案。
*/$this->setconfig();
$this->createconfigfile(); //
建立配置檔案
$this->clearcache(); //
清除快取檔案
$this->createdatafiles(); //
生成資料檔案
$this->prepareproxys();
$this->restart();

php注釋標準

4.1 塊注釋 塊注釋通常用於提供對檔案，方法，資料結構和演算法的描述。塊注釋被置於每個檔案的開始處以及每個方法之前。它們也可以被用於其他地方，比如方法內部。在功能和方法內部的塊注釋應該和它們所描述的 具有一樣的縮排格式。塊注釋之首應該有乙個空行，用於把塊注釋和 分割開來，比如 這裡是塊注釋 塊注釋...

PHP標準注釋

php是一門及其容易入門的語言，剛入門的新手不到幾分鐘的時間可能就會用echo列印出乙個hello world 但是他是真正的程式設計師嗎？怎麼來定義程式設計師呢？如果想真正成為乙個程式設計師，那麼就必須遵循一套程式書寫規範，我們經常編寫一些函式，但是這些函式可能也只有自己能看得懂，甚至過一段時間自...

PHP標準注釋

2018 12 14 14 08 網頁設計 標籤 php 425 2 php是一門及其容易入門的語言，剛入門的新手不到幾分鐘的時間可能就會用echo列印出乙個hello world 但是他是真正的程式設計師嗎？怎麼來定義程式設計師呢？如果想真正成為乙個程式設計師，那麼就必須遵循一套程式書寫規範。我們...