Pod::Coverage

Pod::Coverage is a Perl module that checks if the documentation of a module is comprehensive.
Download

Pod::Coverage Ranking & Summary

Advertisement

  • Rating:
  • License:
  • Perl Artistic License
  • Price:
  • FREE
  • Publisher Name:
  • Richard Clamp and Michael Stevens
  • Publisher web site:
  • http://search.cpan.org/~rclamp/

Pod::Coverage Tags


Pod::Coverage Description

Pod::Coverage is a Perl module that checks if the documentation of a module is comprehensive. Pod::Coverage is a Perl module that checks if the documentation of a module is comprehensive.SYNOPSIS # in the beginnning... perl -MPod::Coverage=Pod::Coverage -e666 # all in one invocation use Pod::Coverage package => 'Fishy'; # straight OO use Pod::Coverage; my $pc = Pod::Coverage->new(package => 'Pod::Coverage'); print "We rock!" if $pc->coverage == 1;Developers hate writing documentation. They'd hate it even more if their computer tattled on them, but maybe they'll be even more thankful in the long run. Even if not, perlmodstyle tells you to, so you must obey.This module provides a mechanism for determining if the pod for a given module is comprehensive.It expects to find either a =head(n>1) or an =item block documenting a subroutine.Consider: # an imaginary Foo.pm package Foo; =item foo The foo sub = cut sub foo {} sub bar {} 1; __END__In this example Foo::foo is covered, but Foo::bar is not, so the Foo package is only 50% (0.5) covered Requirements: · Perl


Pod::Coverage Related Software