DocBlocks:@uses和@see之间的区别

时间:2013-03-27 10:55:20

标签: documentation phpdoc docblocks

相当直截了当的问题 - 在编写docblocks时,我应该如何确定是否应该在另一个结构元素@uses中说出结构元素,何时应该告诉人们@see另一个元素?

我做了一些谷歌搜索和一些SO搜索没有太多运气,我唯一的区别是@uses有一个匹配的@used-by标签,而{{1}是单向的。这是否意味着@see / @uses@used-by更受欢迎,还是更多呢?

干杯。

1 个答案:

答案 0 :(得分:1)

当我想强调下面的方法使用@uses标记标识的方法/属性时,我选择@uses。但是,使用@uses的关键原因是创建双向@uses - @ used-by链接。认真地保持@uses的一致性最终意味着我可以查看我的文档中的方法/属性并查看其上的@ used-by标记列表,从而一目了然地了解这个方法/属性可以产生多大影响。这在准备重构全局变量时特别有用,这些变量的用法隐藏在方法的代码中。

我使用@see表示对于下面的方法,还有一些有趣的理由也可以看一看@see点的位置。如果有一个由此方法和@see方法操作的类属性,特别是以某种类似/相关的方式操作,我可能会在这两种方法上放置@see标记,甚至可能对该属性使用@uses。

TL; DR?我只使用@uses来表明该方法实际上使用了@uses目标。我会将@see用于任何其他“你应该知道这个其他事情”的理由。