view release on metacpan or  search on metacpan

lib/Devel/Comments.pm  view on Meta::CPAN

passed on the C<use> line when loading the module (see L<"INTERFACE">).
The following table summarizes the behaviour:

         Value of
    $ENV{Devel_Comments}          Equivalent Perl

            1                     use Devel::Comments;
            0                      no Devel::Comments;
        '###:####'                use Devel::Comments qw(### ####);
        '### ####'                use Devel::Comments qw(### ####);

To enable the C<Devel_Comments> environment variable, you need to load the
module with the C<-ENV> flag:

    use Devel::Comments -ENV;

Note that you can still specify other arguments in the C<use> statement:

    use Devel::Comments -ENV, qw(### #####);

In this case, the contents of the environment variable replace the C<-ENV> in
the argument list.

=head1 DEPENDENCIES

The module requires the following modules:

=over

=item *

Filter::Simple

=item *

version.pm

=item *

List::Util

=item *

Data::Dumper

=item *

Text::Balanced

=back

=head1 INCOMPATIBILITIES

It is known that IO::Capture::Tie_STDx 0.05 does not 
implement a C<TELL()> method. This causes trouble if smart output is directed 
to a captured filehandle. Workaround is to install IO::Capture::Tellfix, 
included with this distribution. 

Not recommended to use DC is combination with other source filters. 

=head1 BUGS AND LIMITATIONS

Tellfix is ugly and causes a warning to be raised under some circumstances. 
Intent is to move off IO::Capture::* altogether in favor of Test::Trap;
so this issue will not be fixed directly. 

The current testing paradigm is flawed; it has too many dependencies, 
including perl 5.010. We ship with a cut-down "user" test suite, which should 
run fine under perl 5.008; this is mostly a rehash of the original 
Smart::Comments test suite and doesn't fully exercise DC's new features. 
Those interested may want to run the full test suite found in t/all/. 

A number of features are marked as unimplemented. 

Bugs outstanding against SC 1.0.4 can be found at 
L<https://rt.cpan.org/Dist/Display.html?Queue=Smart-Comments> and they are 
probably all present in this version of DC. You are welcome to relist against 
DC any that you find; but I will be working off that list, too. 

Please report any bugs or feature requests to 
L<https://rt.cpan.org/Public/Bug/Report.html?Queue=Devel-Comments>
or email C<< <XIONG@cpan.org> >>. These are welcome and will be acted upon. 

=head1 TODO

Argment passing will be made orthogonal, as much as possible. Arguments can 
be passed either as one flat list or as named elements of a single hashref. 

Debug levels passed numerically and numerical introducers. 

Invocation of client methods for dumping objects. 

Pass-through execution of arbitrary debugging code. 

Police up scraps of stuff currently left in caller's namespace. Store all 
state entirely within DC. 

=head1 THANKS

=over

=item *

Mike Stok C<< <MIKESTOK@cpan.org> >> 
for reporting RT#62599 I<and> fixing it.

=item *

Kevin Ryde for reporting RT#69712 and reviving the project.

=back

=head1 AUTHOR

Xiong Changnian  C<< <XIONG@cpan.org> >>

=head1 LICENCE AND COPYRIGHT

Copyright (c) 2010, 2011, Xiong Changnian  C<< <XIONG@cpan.org> >>. All rights reserved.

Based almost entirely on Smart::Comments,