是否可以链接到我的项目的另一个方法/类/属性/等,内联在@param标记中?就像这样:
@param
/** * My method's description. * * @param string $myArg Pass here result of {@link myOtherMethod()}. * * @return bool */ public function myMethod($myArg) { // TODO: code here. } ...
eiee3dmh1#
PhpDoc(phpDocumentor)和doxygen都支持到其他方法的内联链接。
PhpDoc
phpDocumentor
doxygen
use:
{@link myOtherMethod()}
或者:
{@link MyClass::myOtherMethod()}
但与doxygen不同的是,似乎内联链接并非在任何地方都受支持,请参见PhpDocs: Link to another method in "@deprecated" tag's description?
{@link #myOtherMethod}
{@link MyClass#myOtherMethod}
或者干脆:
myOtherMethod()
PHP
1条答案
按热度按时间eiee3dmh1#
PhpDoc
(phpDocumentor
)和doxygen
都支持到其他方法的内联链接。用于phpDocumentor
use:
或者:
但与
doxygen
不同的是,似乎内联链接并非在任何地方都受支持,请参见PhpDocs: Link to another method in "@deprecated" tag's description?对于脱氧剂:
或者:
或者干脆:
phpDocumentor
语法,因为它更广为人知(至少PHP
开发人员知道)。doxygen
支持相同的PhpDoc
语法,使用doxygen
生成文档就没有问题了,因为一旦文档被编译,使用什么工具编译它们就无关紧要了,它们都是可读的。