2012-03-29 29 views
9

在PHP中,我注意到人們在源代碼註釋中放置了「@」符號。一個很好的例子是任何WordPress。當你看到源代碼,你看到的東西像評論中的「@」符號是什麼?

/** Results of the last query made 
* 
* @since 1.0.0 
* @access private 
* @var array|null 
*/ 
var $last_result 

(WP-db.php中,124線)

它改變了語法在我的編輯凸顯所以我假設它做一些事情,但我不確定它做了什麼。有人會解釋評論中「@」符號的作用嗎?

回答

7

這些是PHPDoc評論。他們的目的是機器可解析,以支持自動化文檔和IDE代碼完成。

0

這樣的記號可用作創建評論之外的文檔解析器的一種方式。所以,第一個@可以被識別爲版本,第二個可以被識別爲參數等等。

0

這通常是爲了從源代碼文件自動生成文檔而完成的。在這種情況下,@_用於識別有關變量的元數據。 @var可以告訴文檔解析器以下文本描述變量等等,而不是按順序評估。

3

以前的回答是正確的,說明源註釋中的@符號是PHPDoc註釋。它們還可以用於稱爲「註釋」的東西,它將元數據添加到代碼的某個元素,並且可以影響應用程序的行爲。它在PHP中沒有得到官方的支持,但它已經討論了好幾年,並且正在Symfony,Doctrine和其他項目中使用。

通過所有的事情PHP的幻燈片(與我無隸屬關係),並標註一個很好的解釋:

http://www.slideshare.net/rdohms/annotations-in-php-they-exist

註釋的主題的一般性討論:

http://en.wikipedia.org/wiki/Annotation

的來自2010年的關於在PHP中實現註釋的RFC:

http://wiki.php.net/rfc/annotations

相關問題