为什么不鼓励在文档块中使用@USES标记?

时间:2015-03-24 作者:Stiofan O\'Connor

看见inline documentation standards

注意:此标签在过去使用过,但不应再使用。

有什么好处?

我正在构建一个插件,从插件/主题的源代码构建一个codex,我认为@uses 标签非常适合将函数链接到挂钩,挂钩链接到函数。

1 个回复
SO网友:gmazzap

我不是百分之百肯定,但我想这是因为@uses 可以覆盖@see

来自phpDocumentor文档

@用法与@see非常相似,有关格式和结构的详细信息,请参阅@see的文档。@uses标记与@see有两个不同之处@see是单向链接,这意味着包含@see标记的文档包含指向其他文档的链接。@uses标记自动在其他文档中创建一个虚拟的@usedby标记,该标记链接到包含@uses标记的文档。换句话说,它与@see完全一样,只是自动添加了一个返回链接。

另一个区别是@uses只接受一个要链接的元素以及该元素的描述。

很可能,WP的人认为不值得有两个如此相似的标签,但只保留一个。

顺便提一下@uses 是一个很好的标签。如果您想支持它,只需执行它并在文档中记录它的支持。

结束

相关推荐

WordPress Codex的本地副本?

有时我想在没有网络连接的情况下开发WordPress主题。我需要Function Reference 和Template Tags 要有生产力。我搜索了一份可下载或SVN版本的Codex 但找不到。最后我试着用镜子把它照出来wget, 但结果参差不齐(太大了!)。有更好的办法吗?