PHPDoc & quot; Для этого файла не найдено резюме & quot; ошибка

Я пытаюсь сгенерировать PHPDocs для написанного мной кода, но постоянно получаю сообщение об ошибке, сообщающее, что «для этого файла не найдено резюме». Я пытался с помощью этот страница, которая имела похожую тему, но это не помогает этой конкретной проблеме.

Насколько я могу судить, приведенный ниже пример правильно отформатирован, но все равно выдаст ошибку.

<?php
namespace App\Example;

/**
* This is the summary section for the file itself.
*
* This Goes into more depth about the whole file.
*`enter code here`
* @author Some Author
*
*/

/**
* Some standard first function (function_1). This is a long description of the file just so that it
* looks good in the example doc page. Don't worry about what all of this says, it is meaningless. This
* is all part of the first paragraph, and is the main summary. the next part is the more detailed stuff
* people can read if they want.
*
* Lorem ipsum dolor sit amet, at falli maluisset nec, paulo deterruisset no vix. Prompta ancillae
* cu mea, insolens recteque te pri, vulputate disputando persequeris id quo. Ei iracundia
* efficiendi eos. Eam ut illum euismod erroribus, praesent assueverit at vix. Wisi nostrum ad vel,
* pro an eros repudiare, ei mea fierent appareat deseruisse.
*
* @param ParameterType1 $param1 Param1 description.
* @param string $param2 Param2 description.
* @param string $param3 Param3 description.
* @param $param4 - Param4 description.
*
* @return void
*/

function function_1(ParameterType1 $param1, $param2, $param3, &$param4)
{
//This is the code.
}/**
* Some standard second function (function_2) This is a long description of the file just so that it
* looks good in the example doc page. Don't worry about what all of this says, it is meaningless. This
* is all part of the first paragraph, and is the main summary. the next part is the more detailed stuff
* people can read if they want.
*
* Lorem ipsum dolor sit amet, at falli maluisset nec, paulo deterruisset no vix. Prompta ancillae
* cu mea, insolens recteque te pri, vulputate disputando persequeris id quo. Ei iracundia
* efficiendi eos. Eam ut illum euismod erroribus, praesent assueverit at vix. Wisi nostrum ad vel,
* pro an eros repudiare, ei mea fierent appareat deseruisse.
*
* @param ParamType2 $param1 Param1 description.
* @param $param2 - Param2 description.
*
* @return string $returnStatement
*/

function function_2(ParamType2 $param1, &$param2) {
//This is the code.
return $returnStatement;
}

?>

Я уверен, что это простое исправление в коде для правильной генерации DOC, но это было неприятно, пытаясь выяснить, что является причиной ошибки.

1

Решение

Задача ещё не решена.

Другие решения

Других решений пока нет …

По вопросам рекламы ammmcru@yandex.ru
Adblock
detector