Documentation DocBlocks:@uses和@see之间的区别
相当简单的问题-在编写docblock时，我应该如何确定是否应该说一个结构元素Documentation DocBlocks:@uses和@see之间的区别,documentation,phpdoc,docblocks,Documentation,Phpdoc,Docblocks,相当简单的问题-在编写docblock时，我应该如何确定是否应该说一个结构元素@使用另一个，以及它应该何时告诉人们@查看另一个元素 我在谷歌上搜索了一段时间，但运气不太好，唯一的区别是@uses有一个匹配的@used by标记，而@see是单向的。这是否意味着使用的/@优于@参见 干杯。当我想强调下面的方法使用@uses标记标识的方法/属性时，我选择@uses。不过，我使用@uses的关键原因是创建链接使用的双向@uses--。认真一致地放置@uses最终意味着我可以查看文档中的方法/属性，并在
@使用另一个，以及它应该何时告诉人们@查看另一个元素
我在谷歌上搜索了一段时间，但运气不太好，唯一的区别是@uses
有一个匹配的@used by
标记，而@see
是单向的。这是否意味着
使用的
/干杯。当我想强调下面的方法使用@uses标记标识的方法/属性时，我选择@uses。不过，我使用@uses的关键原因是创建链接使用的双向@uses--。认真一致地放置@uses最终意味着我可以查看文档中的方法/属性，并在其上看到标记使用的@used的列表，从而一眼就能知道这一方法/属性的影响有多广泛。这在准备重构全局变量时特别有用，这些全局变量的用法隐藏在方法代码中 我使用@see表示，对于下面的方法，也有一些有趣的理由可以浏览一下@see点的位置。如果有一个类属性被这个方法和@see方法操纵，特别是以某种类似/相关的方式操纵，我可能会在这两个方法上都加上@see标记，甚至可能在该属性上加上@uses
TL；博士我使用@uses只是为了表明该方法实际上使用了@uses目标。我会使用@see来表示任何其他“您也应该知道这件事”的原因。当我想强调下面的方法使用@uses标记标识的方法/属性时，我选择@uses。不过，我使用@uses的关键原因是创建链接使用的双向@uses--。认真一致地放置@uses最终意味着我可以查看文档中的方法/属性，并在其上看到标记使用的@used的列表，从而一眼就能知道这一方法/属性的影响有多广泛。这在准备重构全局变量时特别有用，这些全局变量的用法隐藏在方法代码中 我使用@see表示，对于下面的方法，也有一些有趣的理由可以浏览一下@see点的位置。如果有一个类属性被这个方法和@see方法操纵，特别是以某种类似/相关的方式操纵，我可能会在这两个方法上都加上@see标记，甚至可能在该属性上加上@uses TL；博士我使用@uses只是为了表明该方法实际上使用了@uses目标。我会使用@see作为任何其他“你也应该意识到其他事情”的理由