Question

phpDocumentor manual says您可以向docblock添加@uses属性以引用已使用的函数并在其中生成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

为manual says @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...*/ }

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

1 个答案: