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

[Michael Stucki]

Hi Ingo,

I have been asked by our developers at snowflake to start with that. Though 
I'm not using Zend atm. I have seen this in action and consider it useful. So 
go ahead (applies to everybody stumbling over such variables).

Although it's a simple change, I would like to see this in Trunk only.

- michael

Ingo Renner wrote on Tuesday 14 August 2007:
> Hi all,
>
> This is a SVN patch request.
>
> 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.
>
>
> Example:
> file: t3lib/class.tslib_pibase.php
> variable: tslib_pibase->cObj
>
> /**
>   * The backReference to the mother cObj object set at call time
>   *
>   * @var tslib_cObj
>   */
>
>
> Branch: Trunk
>
>
> Ingo
>
>
>
>
> _______________________________________________
> TYPO3-team-core mailing list
> TYPO3-team-core at lists.netfielders.de
> http://lists.netfielders.de/cgi-bin/mailman/listinfo/typo3-team-core
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : http://lists.netfielders.de/pipermail/typo3-team-core/attachments/20070814/bb96e5b1/attachment.pgp