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

Question

我目前正在为一个 Restful API 构建一些 phpdoc - 我开始使用 @param doc 语法来通过 POST 标记所需的参数。

但是，在生成 phpdoc 之后，我注意到它拒绝列出这些参数，除非它们与方法本身的输入变量完全匹配。

@uses 和 @see 在涉及 phpdoc 输出时看起来不太好，也没有多大意义。文档的样式/外观与 @param 功能完美融合。

是否有任何方法可以覆盖 PHPDoc 制定的规则，并允许它在文档中生成 @param block ，即使该参数不存在于方法本身中？

Answer 1

如果您想记录您的 API，我建议您使用适当的工具，例如 API Blueprint或 Open API Spec .

并通过使用 Swagger , 你甚至可以使用 annotations (这显然是您想要的)记录 API，然后从中生成文档。

只是不要为此使用 PHPdoc，因为那只是完全混合概念。