vimrc for documenting subs

Category:

Utility Scripts

Author/Contact Info

Scott Cain

Description:

This is a vimrc that will automatically create documentation and skeleton code for a subroutine. To use it, type the name of the new subroutine in a line by itself in vim, the press either F2 for a generic sub or F3 for a Get/Set sub. The result for a generic sub looks like this:

=head2 generic_sub_name
                                                                      
+             
=over
                                                                      
+             
=item Usage
                                                                      
+             
  $obj->generic_sub_name()
                                                                      
+             
=item Function
                                                                      
+             
=item Returns
                                                                      
+             
=item Arguments
                                                                      
+             
=back
                                                                      
+             
=cut
                                                                      
+             
sub generic_sub_name {
    my ($self, %argv) = @_;
                                                                      
+             
                                                                      
+             
}
[download]

and for a get/set sub, like this:

=head2 get_set_name
                                                                      
+             
=over
                                                                      
+             
=item Usage
                                                                      
+             
  $obj->get_set_name()        #get existing value
  $obj->get_set_name($newval) #set new value
                                                                      
+             
=item Function
                                                                      
+             
=item Returns
                                                                      
+             
value of get_set_name (a scalar)
                                                                      
+             
=item Arguments
                                                                      
+             
new value of get_set_name (to set)
                                                                      
+             
=back
                                                                      
+             
=cut
                                                                      
+             
sub get_set_name {
    my $self = shift;
    return $self->{'get_set_name'} = shift if defined(@_);
    return $self->{'get_set_name'};
}
[download]


Your skill will accomplish what the force of many cannot
	PerlMonks