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

メソッドがget/postリクエストを受け入れることを特定する最良の方法と、特定の投稿パラメーターを指定するにはどうすればよいですか. ありがとう。

4

1 に答える 1

1

実際にはそのメソッドに引数を直接渡すわけではないためmanageQuarterBaseHourAction()、 @param タグは本当に必要なものではありません。

メソッドが $_POST スーパーグローバル内のものを内部的に参照することを読者に認識してもらいたいようです。ただし、コード例では、このメソッドでスーパーグローバルに直接触れるのではなく、適切なメソッドにスーパーグローバルに触れることを個別に組み込んでいるようにも見えます。

その側面を考えると、テキストの説明では特定の $_POST キーについてのみ言及することになるでしょう。それ以上のことを行う唯一のポイントは、ドキュメント内の他のコード要素へのハイパーリンクを提供できる場合であり、もちろん $_POST のドキュメントはありません。このクラスの $_POST を管理する他のメソッドが、このメソッドのドキュメントから直接ジャンプできると便利な場合は、@see タグを使用して各メソッドを参照してください。そうすれば、読者がこのメソッドについて読んでいるときに他のメソッドを調べる必要があると思った場合、その @see 行をクリックするだけでそこにジャンプできます。

于 2013-10-03T20:25:14.240 に答える