我使用docblock来记录函数方法,类...通常。
我发现自己使用了适配器模式,因此,我所有的适配器都实现了一个公共接口并返回相同的东西。
公共接口具有记录的所有功能及其名称,返回值,变量等。
是否有一种方法可以使整个适配器类的功能从通用接口中的相同功能继承文档?我知道@inheritDoc
,但是我不确定是否需要为每个函数使用它,或者是否可以将其应用于类docblock,或者这完全不是一个好主意。
将新文档分类为“真实”文档。
答案 0 :(得分:0)
如今,文档生成器和IDE通常知道如何为您完成此继承。只是通过 not 在适配器功能上没有文档块,才应该自动继承接口功能的文档。有时,如果您做创建子文档块,则父文档会被忽略...但是通常,如今,任何解释文档块的逻辑都具有更好的逻辑,可将子文档块信息与父文档块信息合并,并以给定功能的一小块信息。
@inheritdoc
标记经常被误用于尝试完成同一件事,但实际上从未用于此目的。该标签仅具有一项工作-控制子文档中何处显示父级的详细描述。就是这样,仅此而已。