PHPDoc - 在函数中没有param的情况下记录@param?

Eog*_*han 9 php phpdoc

我正在为一个宁静的API构建一些phpdoc - 我开始使用@paramdoc语法来通过POST来记录所需的params.

然而,在生成phpdoc之后,我注意到它拒绝列出这些参数,除非它们与输入变量完全匹配到方法本身.

@uses@see并不好看,也不在这里太大的意义,当它涉及到PHPDoc的输出.doc的样式/外观与@param功能完美搭配.

有没有办法覆盖PHPDoc实施的规则,并允许它@param在文档中生成块,即使方法本身不存在param?

con*_*781 0

您可以通过使用“可选”来做到这一点。IE:

@param string $variable (optional) Blah.

请参阅https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.param.pkg.html上的其他示例。

这将在参数可选、参数不受限制等情况下使用。