我写了一个类foo.pm,它从Web服务中收集一些数据.在foo.pm里面我添加了perldoc来描述功能以及使用的简短指南.它的所有方法都有参考.
我还编写了一个子类cachedFoo.pm,它使用foo.pm作为基类,使用foo的新方法包装自己的构造函数,并使用数据库连接升级foo以缓存结果.我已经将perldoc添加到cachedFoo.pm以获取更多内容.
现在我只希望我的同事使用cachedFoo.pm.我应该将所有继承方法的perldoc从foo.pm复制到cachedFoo.pm,还是应该说“查看基类的访问者文档”?或者可能有另一种方式?
解决方法
只要在界面描述开始时就明确指出其他类就足够了,请参阅下面的最佳实践文档示例.然后,您的pod覆盖测试应该使用
Pod::Coverage::CountParents来考虑继承.
package cachedFoo; ⋮ =head1 INTERFACE =head2 Composition cachedFoo ISA foo DOES somerole All methods and attributes not mentioned here are inherited from L<foo> or mixed in from L<somerole>. =head2 Methods =head3 C<cache_database_thing> Blah blah blah,Mr. Freeman
明确命名每个组合方法不会扩展.我不能推荐这个:
=head3 C<quux> See L<foo/quux>.