Sintaxe Magento 1 PHPDoc incorreta?

Question

Notei as seguintes declarações de estilo PHPDoc no código principal do Magento e posteriormente copiadas nas extensões do Magento:

/** @var $varName Mage_Core_Model_Example */

Não deveria seguir o @var [type] [$optionalName] [Optional comment] conceito que o PHPDoc usa?Por exemplo:

/** @var Mage_Core_Model_Example $optionalVarNameOrComment Optional comment here */

Ou mais simplesmente na prática:

/** @var Mage_Core_Model_Example */
$example = Mage::getModel('core/example');

---

Editar: talvez seja apenas inconsistência entre a equipe de desenvolvimento ...Encontrei um exemplo do que consideraria correto @var bloquear ao revisar as alterações do EE 1.14.2:

# app/code/core/Mage/Adminhtml/Model/Sales/Order/Create.php - 1531:
/** @var Mage_Sales_Model_Order $oldOrder */

Answer 1

Você não obterá uma resposta satisfatória a menos que haja regulamentos de codificação do Magento 1 publicados em algum lugar.

No entanto, Magento 1 segue o Padrão de codificação Zend, que por sua vez referências ao PHPDoc.Então, em teoria, sua observação está correta.

Na prática, quaisquer regulamentos relativos ao PHPDoc podem não ter sido muito rígidos, nem forçados pela validação automática.Conseqüentemente, os desenvolvedores fizeram o que funcionou dependendo do seu IDE.PHPStorm suporta ambas as variações.Netbeans e Eclipse um e outro – t.b.c.

Para Magento 2 existem padrões publicados que permitem explicitamente ambos os formatos.