php - 如何在 phpDocumentor 2 中为函数使用 @uses

Question

phpDocumentor手册说您可以将@uses属性添加到 docblock 以引用 used 函数并在那里生成 used_by 属性。当我主要编写程序 php 代码时，我喜欢用@uses标签引用我的函数

我这样尝试过，没有收到任何警告或错误，但它生成的不是真正的链接，也没有 used_by 链接。我唯一得到的是带有函数名称文本的属性我的错误在哪里？

/**
 * Searches for string in given field and returns Array of objects
 * @param $strSearch    string to be searched for in database
 * @return array
 * @uses function mysqlConnect
 */
function blablablub($strSearch){ /*here goes the code...*/ }

Answer 1

正如手册所说 ，@uses 标签可用于记录任何元素（全局变量、包含、页面、类、函数、定义、方法、变量）

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

  /**
 * Searches for string in given field and returns Array of objects
 * @param $strSearch    string to be searched for in database
 * @return array
 * @uses subclass sets a temporary variable
 * @uses subclass::$foo this is compared to TEST_CONST
 * @uses TEST_CONST compared to subclass::$foo, we
 * @uses some_function
 */
  function blablablub($strSearch){ /*here goes the code...*/ }