Почему открывающая последовательность phpDoc имеет две звезды в `/ **` вместо `/ *`
Вещи кажутся вполне визуально и машинно-четкими, просто /*
https://phpdoc.org/docs/latest/getting-started/your-first-set-of-documentation.html Должен сказать что-то об этом, но не делает.
Твои мысли?
Решение
Есть разница между обычным комментарием php (/* ... */) и DocBlock (/** ... */) (или же PHPDoc).
PHP интерпретирует оба как комментарии, однако при использовании IDE — они могут анализировать DocBlocks и предоставить вам лучший опыт программирования (с подсказками типов и автозаполнениями), и если вы хотите, вы можете использовать их для экспорта полной документации вашего кода (пакетов) / классы / функции / и т.д.).
Если взять, например, этот код:
<?php
/**
* A summary informing the user what the associated element does.
*
* A *description*, that can span multiple lines, to go _in-depth_ into the details of this element
* and to provide some background information or textual references.
*
* @param string $myArgument With a *description* of this argument, these may also
* span multiple lines.
*
* @return void
*/
function myFunction($myArgument)
{
}
Вы можете видеть, что функция myFunction ничего не возвращает (@return void) и принимает только один параметр ($myArgument) который должен быть строкой.
Для экспорта полной документации вы можете использовать инструмент phpDocumentor.
Другие решения
Других решений пока нет …
detector