所以,基本上我有以下设置：
class A {
/**
* This is some documentation
*/
public function foo() {}
}
class B extends A {
/**
* This documentation is way more specific than in class A
*/
public function foo() {}
}
当我尝试用phpDocumentor2记录它时,它会在方法foo()中显示B类“这是一些文档”,但是我想说它“这个文档比A类更具体”.在phpDocumenter 1中,一切看起来都像预期的那样.
那么,这里发生了什么？这是phpDocumentor2的新默认行为吗？如果是这样,有没有办法改变它？或者这只是一个错误？
注意：在做我的研究时,我经常碰到{@inheritDoc},但我想要有完全相反的行为.
解决方法:
你期望在你的例子中看到的正是应该发生的事情 – A :: foo()应该显示“这是一些文档”而B :: foo()应该显示“这个文档比类更具体一个”.如果没有发生,那就是一个错误.请在https://github.com/phpDocumentor/phpDocumentor2开一个问题.
顺便说一句,{@inheritdoc}的意图是将A :: foo()的长描述嵌入B :: foo()整体文档的中间位置.通过在B :: foo()的docblock中有描述,你可以覆盖B :: foo()自动继承的A :: foo()信息的正确默认行为. {@inheritdoc}标签是专门创建的,因此您有机会为B :: foo()编写描述,并且仍然能够包含A :: foo()中的描述.您在B :: foo()的docblock中放置{@inheritdoc}意味着您可以准确控制A：foo()的描述将出现在B的整体描述中.
我在{@inheritdoc}中看到的绝大多数用法都是人们认为它必须仅用于从父级继承描述和标签的地方.我认为这是由于phpDoc 1.x中的错误实现,其中自然继承无法正常工作,因此人们认为必须使用标签,即使它仍然没有给他们所追求的东西.
标签：php,phpdoc,phpdocumentor2 来源： https://codeday.me/bug/20190703/1368326.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。