PhpDocs：链接到“@param”标签描述中的另一个方法？

Question

是否可以链接到我项目的另一个方法/类/属性/等，在@param标记内内联？

像这样：

/**
 * My method's description.
 *
 * @param string $myArg Pass here result of {@link myOtherMethod()}.
 *
 * @return bool
 */
public function myMethod($myArg) {
    // TODO: code here.
}

...

Answer 1

PhpDoc ( phpDocumentor ) 和doxygen都支持内联链接到其他方法。

对于 phpDocumentor

使用：

{@link myOtherMethod()}

或者：

{@link MyClass::myOtherMethod()}

但与doxygen不同的是，似乎内联链接并非处处受支持，请参阅PhpDocs：链接到“@deprecated”标签描述中的另一种方法？

对于氧气：

{@link #myOtherMethod}

或者：

{@link MyClass#myOtherMethod}

甚至只是：

myOtherMethod()

请注意，未编译文档的人类可读性很重要，因此应使用phpDocumentor语法，因为它更为人所知（至少PHP开发人员）。

但是一旦doxygen支持相同的PhpDoc语法，用doxygen生成文档就没有问题了，因为一旦文档被编译，使用什么工具编译它们并不重要，它们都是可读的。