Adam Kennedy > Perl-Metrics-0.09 > Perl::Metrics::Plugin::Core

Download:
Perl-Metrics-0.09.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  0
View/Report Bugs
Module Version: 0.09   Source  

NAME ^

Perl::Metrics::Plugin::Core - The Core Perl Metrics Package

DESCRIPTION ^

This class provides a set of core metrics for Perl documents, based on very simple code using only the core PPI package.

METRICS ^

As with all Perl::Metrics::Plugin packages, all metrics can be referenced with the global identifier Perl::Metrics::Plugin::Core::metric.

Metrics are listed as "datatype name".

integer tokens

The tokens metric represents the total number of PPI::Token objects contained in the document.

For example, the following one-line document would have a tokens metric of 5 (assuming a single trailing newline)

  print "Hello World!\n";

integer significant_tokens

The significant_tokens metric represents the total number of significant tokens contained in the document.

This filters out things like whitespace and comments, and refers (more or less) to only the parts of the document that actually do something.

For more information on significance, see "significant" in PPI::Element.

SUPPORT ^

Bugs should be reported via the CPAN bug tracker at

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Perl-Metrics

For other issues, contact the author.

AUTHOR ^

Adam Kennedy <adamk@cpan.org>

SEE ALSO ^

Perl::Metrics::Plugin, Perl::Metrics, PPI

COPYRIGHT ^

Copyright 2005 - 2008 Adam Kennedy.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

syntax highlighting: