[TYPO3-core] RFC/FYI: adding @var phpDoc variable comments

[Dmitry Dulepov [typo3]]

Hi!

Ingo Renner wrote:
> Problem:
> When working with PHP IDE / PDT / Zend's PHP Plugin for Eclipse you have 
> code completion on variables the IDE knows their type.
> In some/many (?) cases this is not the case because of TYPO3's usage of 
> t3lib_div::makeInstance().
> 
> Solution:
> To enable code completion even with using makeInstance you can add 
> phpDoc before the variables
> 
> /**
>  * some description for the var
>  *
>  * @var classWhichThisVariableIsOf
>  */
> 
> Comments:
> Since I consider this a nobrainer I will add those comments to variables 
> as I come across variables where it makes sense to add those comments 
> and where they're missing.
> - Unless someone complains about this request.

Huge +1!

-- 
Dmitry Dulepov
TYPO3 freelancer / TYPO3 core team member
Web: http://typo3bloke.net/
Skype: callto:liels_bugs