记录perl代码真的没有比POD更好的方法吗？

Question

我很长一段时间都是Perl程序员,但我在POD中的文档总是有问题.

当我在代码中使用POD注释时,代码很难阅读.当我在文件末尾使用POD注释时,存在文档与代码不同步的危险.

我想念一个类似于Java的文档样式.

/**
 * @description
 * ...
 */

我寻找更简单,更直观的文档样式.有这样的事吗？

Answer 1

快速搜索发现Doxygen Filter声称允许您使用Doxygen样式注释(非常接近Javadoc)来记录Perl代码.

Answer 2

那么,POD是发布Perl文档的公认标准.

我觉得维护也很烦人; 我最近尝试使用Pod :: Weaver来维护文档并在发布时将其构建到Pod中.这有点棘手,因为它在过滤和构建POD方面非常灵活,并且可以使用更多文档(在POD或其他方面).但似乎很有希望.对我来说,提供更多的判断还为时尚早,但似乎很有希望.

希望这可以帮助

Answer 3

为什么你认为使用Pod难以阅读代码？代码难以与周围的其他代码一起阅读吗？也许你在代码的某个特定部分投入太多,而不是编写小方法等等.你确定你的代码不是很难读的吗？

您不必将所有文档放在代码的末尾.Pod与代码完全一致,允许您将子例程或方法的文档放在子例程或方法旁边.

你有什么其他问题与Pod？