PHP 編碼規範(8)_PHP教程

4.5 文檔注釋

文檔注釋描述php的類、構造器，方法，以及欄位(field)。每個文檔注釋都會被置於注釋定界符/**...*/之中，一個注釋對應一個類或成員。該注釋應位於聲明之前：

/**
　* 說明這個類的一些 ...
*/
class Example { ...

注意頂層(top-level)的類是不縮排的，而其成員是縮排的。描述類的文檔注釋的第一行(/**)不需縮排；隨後的文檔注釋每行都縮排1格(使星號縱向對齊)。成員，包括建構函式在內，其文檔注釋的第一行縮排4格，隨後每行都縮排5格。

若你想給出有關類、變數或方法的資訊，而這些資訊又不適合寫在文檔中，則可使用實現塊注釋(見5.1.1)或緊跟在聲明後面的單行注釋(見5.1.2)。例如，有關一個類實現的細節，應放入緊跟在類聲明後面的實現塊注釋中，而不是放在文檔注釋中。

文檔注釋不能放在一個方法或構造器的定義塊中，因為程式會將位於文檔注釋之後的第一個聲明與其相關聯。

http://www.bkjia.com/PHPjc/532596.htmlwww.bkjia.comtruehttp://www.bkjia.com/PHPjc/532596.htmlTechArticle4.5 文檔注釋 文檔注釋描述php的類、構造器，方法，以及欄位(field)。每個文檔注釋都會被置於注釋定界符/**...*/之中，一個注釋對應一個類...

