ePages 6.11.0 - DE_EPAGES/Core/Scripts/Perl/Critic/Policy/DE_EPAGES/Style/RequireCommentForExportedFunctions.pm

Package Perl::Critic::Policy::DE_EPAGES::Style::RequireCommentForExportedFunctions

This module checks if exported functions have a comment This module acts as a custom policy for Perl::Critic. Perl::Critic uses Module::Pluggable to automatically discover all modules in the Perl::Critic::Policy namespace, which is the reason we put this module beyond Perl::Critic::Policy. This policy iterates over all subs (functions) in the current tested module. If the sub has no comment or soe of the common content is missing, a violation is returned. Common content of comments are: - \§function - \§state - \ - \§syntax - Each input variable should be described usng an \§input entry. This policy also checks if packages with Exports have package comments. At least the following values have to be set - \# - \ §parameters none