PHP 編碼規(guī)范(8)
發(fā)表時間:2024-02-05 來源:明輝站整理相關(guān)軟件相關(guān)文章人氣:
[摘要]4.5 文檔注釋文檔注釋描述php的類、構(gòu)造器,方法,以及字段(field)。每個文檔注釋都會被置于注釋定界符/**...*/之中,一個注釋對應(yīng)一個類或成員。該注釋應(yīng)位于聲明之前:/** * 說明這個類的一些 ...*/class Example { ...注意頂層(top-level)的類是不縮...
4.5 文檔注釋文檔注釋描述php的類、構(gòu)造器,方法,以及字段(field)。每個文檔注釋都會被置于注釋定界符/**...*/之中,一個注釋對應(yīng)一個類或成員。該注釋應(yīng)位于聲明之前:
/**
* 說明這個類的一些 ...
*/
class Example { ...
注意頂層(top-level)的類是不縮進的,而其成員是縮進的。描述類的文檔注釋的第一行(/**)不需縮進;隨后的文檔注釋每行都縮進1格(使星號縱向?qū)R)。成員,包括構(gòu)造函數(shù)在內(nèi),其文檔注釋的第一行縮進4格,隨后每行都縮進5格。
若你想給出有關(guān)類、變量或方法的信息,而這些信息又不適合寫在文檔中,則可使用實現(xiàn)塊注釋(見5.1.1)或緊跟在聲明后面的單行注釋(見5.1.2)。例如,有關(guān)一個類實現(xiàn)的細節(jié),應(yīng)放入緊跟在類聲明后面的實現(xiàn)塊注釋中,而不是放在文檔注釋中。
文檔注釋不能放在一個方法或構(gòu)造器的定義塊中,因為程序會將位于文檔注釋之后的第一個聲明與其相關(guān)聯(lián)。