首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >为什么不鼓励在docblocks中使用@ use标记?

为什么不鼓励在docblocks中使用@ use标记?
EN

WordPress Development用户
提问于 2015-03-24 14:56:13
回答 1查看 289关注 0票数 6

请参阅内联文档标准

注意:这个标签在过去已经使用过,但是不应该再使用。

怎么回事?

我正在构建一个插件,以便从插件/主题的来源构建代码索引,我认为@uses标记对于将函数链接到钩子和钩子到函数来说将是完美的。

EN

回答 1

WordPress Development用户

发布于 2015-03-24 16:10:52

我不是百分之百确定,但我想这是因为@uses的使用可以用@see来覆盖

来自phpDocumentor文档

@use与@see非常相似,有关格式和结构的详细信息,请参阅有关@see的文档。@uses标记与@see有两种不同之处。@see是一个单向链接,意思是包含@see的文档包含指向其他文档的链接。@use标记会自动在其他文档中创建一个虚拟@usedby标记,该标记链接到包含@uses标记的文档。换句话说,它与@see完全一样,除非返回链接是自动添加的。另一个不同之处是@只接受要链接的一个元素,以及该元素的描述。

也许,WP的人决定,它不值得有两个标签如此相似,但只维护一个。

顺便说一句,@uses是个好标签。如果您想要支持它,只需这样做,并在文档中记录它的支持。

票数 5
EN
页面原文内容由WordPress Development提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://wordpress.stackexchange.com/questions/182134

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档