Re:Thoughts on being a programmer
by throwaway-864 on Wednesday August 15, 2012 @04:31AM
(#4385123)
Check out Smart::Comments module in Perl [1].
It allows the specially-formatted comments to produce debugging output.
From the 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);
}
[1] https://metacpan.org/module/Smart::CommentsNoooooo..... Not magic comments.............
Magic comments are evil, the pox of the earth, etc. I have nothing good to say about comments as code. This totally messes up the separation between code and comment.
The typical case where this happens is that the logging was added because of some bug somewhere and this was put in place to figure out what was going on with total. See it as an archaeological record more than anything else ;-)
I sort of wish someone would allow comments and logging to be combined as language features.