我目前正在为一个 Restful API建立一些phpdoc-我开始使用@param
doc语法在POST上指定所需的参数。
但是,生成phpdoc之后,我注意到它拒绝列出这些参数,除非它们与方法本身中的输入变量完全匹配。
当涉及到phpdoc输出时,@uses
和@see
看起来不太好,在这里也没有多大意义。该文档的样式/外观非常适合@param
功能。
有什么方法可以覆盖PHPDoc制定的规则,并允许它在文档中生成@param
块,即使该参数本身不存在于方法中?
最佳答案
如果要记录您的API,建议您使用诸如API Blueprint或Open API Spec之类的适当工具。
通过使用Swagger,您甚至可以使用annotations(显然是您想要的)来编写API文档,然后从中生成文档。
只是不要使用PHPdoc,因为这只是混在一起的概念。