#186 Perl variables: support 'use vars' declaration

open
nobody
Symbols (7)
5
2012-09-14
2011-05-17
Anonymous
No

Currently it looks like ND only supports documenting a variable declared like

# <description of $var>
my $var;

(or with 'our' instead of 'my'). However, this is another very common "Perly" way to declare lexical variables:

use vars qw($scalarVar1 $scalarVar2 @listVar %hashVar);

It would greatly enhance the "natural" coding vs documentation tradeoff for ND to support the 'use vars' declarations, although I recognize that each var would have to be declared on its own to have a unique description:

use vars qw($scalarVar1);  # <description of $var1>
use vars qw($scalarVar2);  # <description of $var2>
use vars qw(@listVar);       # <description of @listVar>
use vars qw(%hashVar);    # <description of %hashVar>

Note that the "inline description" is an enhancement from another feature request, 3303584.

Discussion