phpDoc経由で関数内の変数を文書化する方法

Question

私はPHPDocのPHP（laravel）コードのコメント標準とAPIドキュメントの生成のためのApiGenを使用しています。

情報を表示するために使用できるタグが多数あることは知っています。

define（）ステートメント、関数、クラス、クラスメソッド、クラスvars、include（）ステートメント、およびグローバル変数はすべて文書化できます。

しかし、今は関数内にある変数を文書化したいと思います。例えば
は、私はこのような機能を持っていると仮定します

  /** 
     * @param Request $request 
     * @param   $course_id 
     * @param   $lesson_id 
     * @param Content $content 
     * 
     * @return array 
     * 
     */ 
     public function SaveOnePageTest (Request $request, $course_id, $lesson_id, \App\Content $content) 
     { 
      /** 
      *I want to document this variable that how does this and What used to be? 
      */ 

      $doneTest = DoneTest::find($done_test_id); 

      /** 
      *or this variable 
      */ 
      $parentQuestions = $doneTest->parent_test->questions; 
     } 

は、この場合の解決策はありますか？

Answer 1

この種のドキュメントツール/構文は、ライブラリ/ソフトウェアAPIを消費する人を支援するために開発されました。

エンドユーザーがローカル変数にアクセスすることはできないため、ドキュメントに実際の変数を公開する必要はありません。

内部コードを文書化することはできますが、PHPDocを使用してこれを行う標準的な方法はありません。