Perl 学习手札之十五：Documentation with POD

Perl 学习手札之十五：Documentation with POD

Why use pod??

 POD is "plain old documentation".

 It's a simple language for uniform documentation.

 It's very easy to use.

 

POD主要是用于模块

Example.pm

 

__END__

=head1 NAME

Template - Description goes here

=head1 SYNOPSIS

     use Template
     my  $o = Template->new;

=head1 METHODS

=over  4

=item B<new>

Constructs a new Template object. 

Returns a blessed Template object reference.

=item B<method>

Describe the method here 

=back

=head1 AUTHOR

Written by Your Name

=head1 HISTORY

    Version history here. 

=cut

这个还是要结合pod的源代码和最终的pod来看。

 

 

 

posted on 2012-03-17 16:50 韩英武 阅读( ...) 评论( ...) 编辑 收藏

转载于:https://www.cnblogs.com/hanleilei/archive/2012/03/17/2403351.html