in reply to Easily catalog subroutines with a synopsis comment

I personnally prefer to append a short synopsis right after the declaration, so that it appears in the the Ctags and allows me to use it as an usage hint with my editor (Nedit). I also insert the documentation for each function after this synopsis:
sub addrecord { #****m* DataFile/addrecord # USAGE # $bdlfile->addrecord([field => value, field => value...]) # Create a record and initialize it according # to file format (POF, BDL) # RETURNS # obj ref DataRecord #*** my $self = shift; my %data = @_; }
Then in my editor, if I select the word addrecord in my code and hit Ctrl+', I'll see the "USAGE" line.