略語設定

Vim

.vimrc に下記を追加。

iab papp <ESC>:r ~/.vim_templates/perl_application.pl<CR>
iab ppkg <ESC>:r ~/.vim_templates/perl_package.pl<CR>
iab pcls <ESC>:r ~/.vim_templates/perl_class.pl<CR>
iab psub <ESC>:r ~/.vim_templates/perl_subroutine.pl<CR>

テンプレートファイルはそれぞれ・・・

perl_application.pl

#!/usr/bin/perl
=head1 NAME

    <application name> - One-Line description

=head1 VERSION
=head1 USAGE
=head1 DESCRIPTION
=head1 BUGS AND LIMITATIONS
=head1 SEE ALSO
=head1 AUTHOR

    Author Name <E-Mail>

=head1 COPYRIGHT

    Copyright (c) 2000-2006 XXXX Co.,Ltd. All rights reserved.

=cut

#============================================================================
#   USE
#============================================================================
use strict;
use warnings;

#============================================================================
#   DEFINED
#============================================================================

#============================================================================
#   SUBROUTINES
#============================================================================

perl_package.pl

package XXXX;
=head1 NAME

    <package name> - One-Line description

=head1 VERSION
=head1 SYNOPSIS
=head1 DESCRIPTION
=head1 BUGS AND LIMITATIONS
=head1 SEE ALSO
=head1 AUTHOR

    Author Name <E-Mail>

=head1 COPYRIGHT

    Copyright (c) 2000-2006 XXXX Co.,Ltd. All rights reserved.

=cut

#============================================================================
#   USE
#============================================================================
use strict;
use warnings;

#============================================================================
#   DEFINED
#============================================================================

#============================================================================
#   SUBROUTINES
#============================================================================

1;

perl_class.pl

package XXXX;
=head1 NAME

    <class name> - One-Line description

=head1 VERSION
=head1 SYNOPSIS
=head1 DESCRIPTION
=head1 BUGS AND LIMITATIONS
=head1 SEE ALSO
=head1 AUTHOR

    Author Name <E-Mail>

=head1 COPYRIGHT

    Copyright (c) 2000-2006 XXXX Co.,Ltd. All rights reserved.

=cut

#============================================================================
#   USE
#============================================================================
use strict;
use warnings;

use Class::Std;

#============================================================================
#   CLASS
#============================================================================
{
    #========================================================================
    #   ATTRIBUTES
    #========================================================================

    #========================================================================
    #   METHODS
    #========================================================================

}

1;

perl_subroutine.pl

#----------------------------------------------------------------------------
#   Name       : name - One-Line description
#   Parameters : none
#   Returns    : none
#   Throws     : no exceptions
#   Comments   : none
#   See Also   : n/a
#----------------------------------------------------------------------------
sub  {
    my () = @_;
}

現在、私がお世話になっている会社では、POD形式のドキュメントを受け入れてもらえなかったので、POD とオリジナルのコメントの折衷案を提案中。よって、上記のようなテンプレートとなっている。

後々、Subversion のリポジトリに commit した際、Trac の Wiki に pod2text か pod2html の出力を反映させる予定。