程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> 網頁編程 >> PHP編程 >> 關於PHP編程 >> PHP 編碼規范(8)

PHP 編碼規范(8)

編輯:關於PHP編程

4.5 文檔注釋

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


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

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

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

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


  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved