NAME
Perl::Metrics2::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 bytes
The bytes metric represents the number of bytes in the file.
integer lines
The lines metric represents the number of raw lines in the file.
integer sloc
The sloc metric represents Source Lines of Code. That is, raw lines minus __END__ content, __DATA__ content, POD, comments and blank lines.
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-Metrics2
For other issues, contact the author.
AUTHOR
Adam Kennedy <adamk@cpan.org>
SEE ALSO
Perl::Metrics::Plugin, Perl::Metrics, PPI
COPYRIGHT
Copyright 2009 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.