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