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

rqdpfwrv  于 2023-02-03  发布在  PHP
关注(0)|答案(1)|浏览(116)

是否可以链接到我的项目的另一个方法/类/属性/等,内联在@param标记中?
就像这样:

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

...
eiee3dmh

eiee3dmh1#

PhpDocphpDocumentor)和doxygen都支持到其他方法的内联链接。

用于phpDocumentor

use:

{@link myOtherMethod()}

或者:

{@link MyClass::myOtherMethod()}

但与doxygen不同的是,似乎内联链接并非在任何地方都受支持,请参见PhpDocs: Link to another method in "@deprecated" tag's description?

对于脱氧剂:

{@link #myOtherMethod}

或者:

{@link MyClass#myOtherMethod}

或者干脆:

myOtherMethod()
    • 注意**未编译文档的可读性很重要,因此应该使用phpDocumentor语法,因为它更广为人知(至少PHP开发人员知道)。
    • 但是**一旦doxygen支持相同的PhpDoc语法,使用doxygen生成文档就没有问题了,因为一旦文档被编译,使用什么工具编译它们就无关紧要了,它们都是可读的。

相关问题