我正在閱讀其他人的一些PHP代碼,並且該文件在每個meathod之前填充了註釋。 @access和@var是什麼意思?這些評論中的@意味着什麼?
/**
* EE Superobject
*
* @access private
* @var object
*/
private $EE;
很多謝謝!
我正在閱讀其他人的一些PHP代碼,並且該文件在每個meathod之前填充了註釋。 @access和@var是什麼意思?這些評論中的@意味着什麼?
/**
* EE Superobject
*
* @access private
* @var object
*/
private $EE;
很多謝謝!
專門用於phpDocuemntor
編譯文檔。
phpDocumentor的標籤非常相似,對於Sun公司的Java編程語言的JavaDoc工具標籤。如果標籤只是DocBlock新行中的第一行,則只能解析標籤。只要不開始新行,您可以在整個文檔中自由使用@字符。舉個例子:
/** * tags demonstration * @author this tag is parsed, but this @version tag is ignored * @version 1.0 this version tag is parsed */下面是標準的標籤列表:
@access @author @copyright @deprecated @example @ignore @internal @link @see @since @tutorial @version inline {@internal}} inline {@inheritdoc} inline {@link}
這不是特定於PHPDoc,有許多文檔生成器利用這個。 – 2013-04-11 22:31:26
它是由一些文檔生成工具來生成用於註釋說文檔。
這些是PHPDoc標籤:http://en.wikipedia.org/wiki/PHPDoc它們用於描述類或函數的某些屬性;該文檔是從上述類/函數的註釋中自動生成的。
這不是PHPDoc所特有的,有許多文檔生成器利用它。 – 2013-04-11 22:32:13
@crypticツ我的意思是PHPDoc作爲一種格式,而不是一種工具。事實上,這種格式得到衆多發電機的支持,這是一件好事。我想「docblocks」將是一個更合適的名稱,但我認爲「PHPDoc標籤」更加明確。 – 2013-04-12 05:50:22
docblock標記 - 用於以可以使用PHPDocumentor或類似方法生成自動文檔的方式記錄類/方法/屬性;也可以通過IDE自動完成 – 2013-04-11 22:10:54