什么时候应该在我的内联文档中为函数和类方法使用@see标记?

时间:2018-03-27 作者:vladlu

这个coding standards 使用“请参阅”的状态;对中高度依赖的函数、方法或类的引用"E;

好啊但如果我有一个函数,它总是意味着有人使用它,因为如果没有使用它,就没有必要编写函数。什么是;高度依赖”;意思是这意味着如果我删除一个函数,依赖函数将无法正常工作?仍然是每个函数,我仍然应该始终使用@请参阅;标签

如果我查看WP或WC代码@请参阅;标签以某种方式随机使用。

我真的不明白。请解释一下。我应该在什么时候使用@请参阅;标签

1 个回复
最合适的回答,由SO网友:Mark Kaplun 整理而成

“@see”标记以某种方式随机使用

难怪任何文档最终都取决于程序员对哪些内容值得记录以及如何记录的决定。

一般来说,文档不应该是对代码的口头描述,除非代码非常重要,但要添加一个人性化的总结,说明代码的作用和原因。因此,代码中使用的函数不值得在@see 因为它们已经在代码中了。当对不同函数的工作方式存在某种依赖时,应该使用它,因为您可以以一种或另一种形式从它获取输入,或者它将处理您的输出(这里对输入和输出的定义非常宽松)。

因此,这取决于判断。你能理解为什么函数A不知道函数B的任何内容就做了什么吗?如果是,则@see 不需要,但如果例如A设置了一个全局变量供B使用,则两者可能都应该包含对彼此的引用(显然好的代码不应该有这样的东西;)。

结束

相关推荐

Buddypress Full documentation

我已经搜索了很多关于buddypress挂钩(操作、过滤器)和函数的完整文档列表,但对提供的有限文档并不满意Buddypress.如果我想知道bp_directory_groups_search_form() 没有关于这种方法的具体细节,buddypress-hook也是如此。。。所以任何人都知道完整文档的确切位置。