从接口继承文档



我使用文档块来记录函数方法,类...平常。

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

通用接口记录了所有函数的名称、返回值、变量等。

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

有点"真实"文档的新手。

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

@inheritdoc标签经常被滥用来尝试完成同样的事情,但实际上从未用于此目的。 此标记只有一个工作 - 控制在子文档中显示父文档的长描述的位置。 就是这样,仅此而已,仅此而已。

最新更新