Smart::Comments 1.0.2

Smart::Comments are comments that do more than just sit there.

SYNOPSIS

use Smart::Comments;

my $var = suspect_value();

### $var

### got: $var

### Now computing value...

# and when looping:

for my $big_num (@big_nums) { ### Factoring... done
factor($big_num);
}

while ($error > $tolerance) { ### Refining---> done
refine_approximation()
}

for (my $i=0; $i<$MAX_INT; $i++) { ### Working===[%] done
do_something_expensive_with($i);
}

Smart comments provide an easy way to insert debugging and tracking code into a program. They can report the value of a variable, track the progress of a loop, and verify that particular assertions are true.

Best of all, when youre finished debugging, you dont have to remove them. Simply commenting out the use Smart::Comments line turns them back into regular comments. Leaving smart comments in your code is smart because if you needed them once, youll almost certainly need them again later.