php - 如何通过 phpDoc 记录函数内部的变量

Question

我正在使用 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;
        }

有解决办法吗？

Answer 1

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

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

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

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

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