如何通过phpDoc记录函数内部的变量 - how to documents variables inside functions via phpDoc

how to documents variables inside functions via phpDoc

我使用PHPDoc标准来注释PHP（laravel）代码和ApiGen来生成API文档。

我知道有很多标签可以用来显示信息。

define（）语句、函数、类、类方法和类变量、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;
        }

这个案子有解决办法吗？

开发这种文档工具/语法是为了帮助用户使用库/软件API。

最终用户无法访问本地变量，因此没有必要在文档中公开它们。

虽然您可以记录您的内部代码，但使用PHPDoc并没有标准的方法。

更新：请注意，您可以使用phpdoc定义变量的类型，以便更好地完成代码，但这不会成为API文档的一部分：

/** @var SomeType $someVar */
$someVar = $this->doSomething();