1

我需要这方面的帮助，当我在编写 PHPDoc 时，我不知道如何为方法指定发布变量。在这段代码中：

 /**
 * 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'];
...

指定该方法接受获取/发布请求的最佳方法以及我如何具体发布参数，因为如果我写@param 仅用于获取参数并且验证器会使我出错。谢谢。

4

1 回答 1

1

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

听起来您希望读者知道您的方法将在内部查看 $_POST 超全局中的内容。但是，在您的示例代码中，看起来您已经将超全局变量的任何接触单独包含在适当的方法中，而不是在此方法中直接接触它们。

鉴于这方面，我可能只会在文本描述中提及特定的 $_POST 键。除此之外，唯一要做的事情是它是否可以提供指向文档中其他代码元素的超链接，当然，$_POST 没有文档。如果您为此类管理 $_POST 的其他方法可能很方便直接从该方法的文档跳转，请使用 @see 标记指向每个方法。这样，如果您的读者认为在阅读此方法时需要查看其他方法，只需快速单击该 @see 行即可跳转到那里。

于 2013-10-03T20:25:14.240 回答