?
快捷搜索:  as  test  1111  test aNd 8=8  test++aNd+8=8  as++aNd+8=8  as aNd 8=8

游艇會線路檢查中心:PHPDoc風格的注釋

?

我們開拓的所有類都邑應用PHPDoc風格的注釋,這樣就能很輕易地為所有類構建API文檔。PHPDoc建立在Sun公司的Javadoc系統根基之上,這是一種為所有函數、參數、變量和包加注釋的簡單措施,以便于開拓職員輕松地重用這游艇會線路檢查中心些函數、參數、變量和包。

只管這一點對付這個Web利用的開拓并不太緊張,但開拓歷程中應用這種風格的游艇會線路檢查中心注釋是一個好習氣。別的,查看本書中的代碼示例時你會發明,每個函數前面有一個PHPDoc注釋塊確鑿很有用。

評釋

本書中列出的代碼平日不包孕PHPDoc注釋,由于在正文中會對這些代碼做具體的解釋和闡明。不過,這個Web利用的下載代碼中會盡可能包孕PHPDoc注釋。

PHPDoc的做法是在每個函數、類或變量定義前放置一個注釋塊。并不是所有環境下都要求如斯,只是在需要的環境下才游艇會線路檢查中心這么做。

每個注釋塊最前面是一個描述,然后是一個或多個可選的參數。例如,向一個函數增添PHPDoc注釋時,可以指定輸入參數和返回值數據。顯然,為變量定義所編寫的PHPDoc注釋則包孕不合的信息。

以下代碼顯示了為一個簡單的用戶自定義函數編寫PHPDoc注釋的例子:

首先要留意注釋塊若何開始。/**唆使PHPDoc解析器一個PHPDoc注釋已經開始。

注釋塊的第一行是一個簡短的描述。我小我的喜愛是在此只寫函數、類或變量的名。

注釋塊中下一部分是一個對照長的描述。在這里我會盡力以一種黑盒的不雅點描述函數、類或變量的感化。也便是說,它會做什么,而不是它如何做。所有詳細的功能或復雜的邏輯都由代碼中的標準注釋來解釋。

評釋

只管不是必需的,不過平日的約定是在/** … */塊每行肇端處包孕一個星號。這主如果為了前進可讀性,還能輕易地發明全部PHPDoc塊。

注釋塊中著末一部分包孕各個PHPDoc參數,解析器用這些參數來更好地鏈接API文檔,從而為你供給實用的文檔。每個參數最前面是一個@,后面緊隨著參數名,然后是該參數所需的信息。

這個例子中可以看到@param和@return參數。@param用于指定函數參數的各個方面:首先是參數的類型(在游艇會線路檢查中心這里,第一個參數是一個字符串);接下來是參數名(這里是$name);著末是一個簡短的描述,闡明輸入的數據該當包孕哪些內容。@return參數用于游艇會線路檢查中心供給函數所返回數據的有關信息:先指定命據的類型,然后是返回數據所包孕內容的一個簡短描述。

免責聲明:以上內容源自網絡,版權歸原作者所有,如有侵犯您的原創版權請告知,我們將盡快刪除相關內容。

您可能還會對下面的文章感興趣:

快三平台开户