如何检查函数是否具有POD(文件文档中的perl)



是否有任何库可以告诉我特定函数是否具有POD?我想把它添加到我们的构建系统中。

与中一样,POD、文件中规定的惯例

=item stuff()
This function does stuff.
=cut
sub stuff {
...
}

我想写这样的

my @functions = get_functions_with_PPI($file);
foreach my $func (@functions) {
unless ( file_has_POD_for_func($file,$func) ) {
say "The function $func is undocumented!";
}
}

我需要一些能执行file_has_POD_for_func的东西,如上面所述。

Pod::Coverage

Pod::Coverage做你想做的事。Devel::Cover在内部使用它。

不要使用PPI,而是使用类似Pod::Simple或Pod:::Parser的东西来解析源文件。

请注意,您将不得不依赖作者,按照惯例提及=item或(更常见的(=head2标记中的函数。

您可能想查看类似Pod::Coverage的源代码,该代码检查Pod中是否提到了模块中的所有功能,假设您还没有尝试这样做。

最新更新