“@see”标记以某种方式随机使用
难怪任何文档最终都取决于程序员对哪些内容值得记录以及如何记录的决定。
一般来说,文档不应该是对代码的口头描述,除非代码非常重要,但要添加一个人性化的总结,说明代码的作用和原因。因此,代码中使用的函数不值得在@see
因为它们已经在代码中了。当对不同函数的工作方式存在某种依赖时,应该使用它,因为您可以以一种或另一种形式从它获取输入,或者它将处理您的输出(这里对输入和输出的定义非常宽松)。
因此,这取决于判断。你能理解为什么函数A不知道函数B的任何内容就做了什么吗?如果是,则@see
不需要,但如果例如A设置了一个全局变量供B使用,则两者可能都应该包含对彼此的引用(显然好的代码不应该有这样的东西;)。