PHP 編碼規范(8)

4.5 文檔註釋

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


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

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

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

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

發佈留言