php - 从接口继承文档

Question

我使用 docblocks 来记录函数方法、类……通常。

我发现自己使用了适配器模式，因此，我所有的适配器都实现了一个通用接口并返回相同的东西。

通用接口包含所有函数，并记录了它们的名称、返回值、变量等。

有没有办法让整个适配器类的函数从公共接口中的相同函数继承文档？我知道@inheritDoc但是我不确定是否需要将它用于每个功能，或者是否可以应用于类 docblock，或者这是否完全是一个坏主意。

有点新的“真实”文档。

Answer 1

如今的文档生成器和 IDE 通常知道如何为您进行这种继承。只要在适配器函数上没有文档块，接口函数的文档就应该自动继承。有时，如果您确实创建了子文档块，则父文档块会被忽略...但是通常，如今任何解释文档块的东西都有更好的逻辑来将子文档块信息与父文档块信息合并，并将其呈现为给定的一个信息块功能。

该@inheritdoc标签经常被滥用以尝试完成同样的事情，但实际上从未用于此目的。这个标签有一个单独的工作——控制子文档在哪里显示父文档的长描述。仅此而已，仅此而已，仅此而已。