Question

我需要帮助，当我编写PHPDoc时，我不知道如何为一个方法提供特定的post变量。在这段代码中：

 /**
 * Show Quarter Base Hour
 * GET: Show select Menu | POST: Get Quarter Base Hour View
 *
 *
 * @return \Symfony\Component\HttpFoundation\Response
 */
public function manageQuarterBaseHourAction()
{
    $form = $this->createForm(new QuarterBaseHour(), null, array('attr' => $this->container->get('formdata')->getSearchAll()));

    if ($this->getRequest()->isMethod('POST')) {

        $form->handleRequest($this->getRequest());

        if ($form->isValid()) {
            $data = $form->getData();
            $year = $data['year'];
            $universe = $data['iduniverso'];
            $ficticious = $data['ficticious'];
            $quarter = $data['quarter'];
...

具体哪种方法接受get / post请求的最佳方式以及如何具体的post参数，如果我写@param只是为了获取params和验证器让我错误。感谢。

Answer 1

由于您实际上并未直接将参数传递给manageQuarterBaseHourAction()方法，因此@param标记确实不是您想要的。

听起来你想让读者意识到你的方法会在内部查看$ _POST超全局中的内容。但是，在您的示例代码中，看起来您还可以单独包含任何触摸超全局的方法，而不是直接在此方法中触摸它们。

鉴于这方面，我只想在文字说明中提及具体的$ _POST键。除此之外的任何事情的唯一要点是它是否可以提供文档中其他代码元素的超链接，当然也没有$ _POST的文档。如果您为此类管理$ _POST的其他方法可能很方便直接从此方法的doc中跳转，请使用@see标记指向每个方法。这样，如果你的读者认为他需要在阅读其他方法的同时阅读其中的方法，可以快速点击@see行来跳转。

在PHPDoc中发布参数

1 个答案: