Описание тега phpdoc
NonePhpDocumentor (phpdoc) - это автоматический инструмент для документирования кода для PHP, основанный на Javadoc.
1
ответ
Исправьте phpDoc, чтобы сообщить IDE тип возвращаемого динамического класса
Рассмотрим этот код: class ParentClass { /** @return ParentClass */ public function getNew(){ return call_user_func(array($this,'generator')); } protected function generator(){ return new static(); // will actually return whatever class calls this c…
08 сен '17 в 13:12
1
ответ
Как документировать использование метода при вызове в абстрактной форме?
В устаревшем проекте я был сбит с толку, когда пытался найти применение метода в phpstorm и безуспешно. /** * @param SomeEntity[] $someEntity * * @return bool */ protected function warmupSomeEntity(array $brandUniverses) { // I want to find this met…
04 фев '15 в 18:14
14
ответов
Разбор комментариев PHP Doc в структуру данных
Я использую Reflection API в PHP, чтобы получить строку DocComment (PHPDoc) из метода $r = new ReflectionMethod($object); $comment = $r->getDocComment(); Это вернет строку, которая выглядит примерно так (в зависимости от того, насколько хорошо ме…
15 янв '11 в 21:55
1
ответ
Отформатируйте phpdoc-тег @param в затмении с пробелами
Я использую Eclipse Juno и PDT. С помощью PHP Formatter я форматирую свой код. Я создал собственный пресет форматирования на основе шаблона PSR-2. проблема Я не могу найти какой-либо вариант конфигурации, чтобы сохранить пробелы в @param комментарии…
10 дек '14 в 20:49
3
ответа
Netbeans PHPDoc локальная переменная не работает
Я пытаюсь документировать свой код чаще, и сейчас я пишу класс и хочу, чтобы он был полностью задокументирован. Однако по какой-то странной причине документация по локальным переменным (конечно, с PHPDoc) не работает.. Я получил это: /** * A functio…
14 окт '15 в 13:09
5
ответов
Phpdoc Резюме не найдено для этого файла
Я установил phpDoc на наш сервер, настроил и т. Д. Он правильно выдает документацию. Мы используем шаблон "Отзывчивый", однако эта ошибка возникает независимо от используемого шаблона. В разделе "Ошибки" каждый отсканированный файл имеет следующую о…
23 янв '14 в 15:33
2
ответа
phpDocumentor - "Находится ли phpdoc в пути или include_path в вашем файле php.ini?"
Я пытаюсь запустить phpDocumentor и получаю эту ошибку... Я много раз искал в Google и не могу найти решение, которое работает, к сожалению, я не смог установить через PEAR, поэтому мне пришлось скачать с их github и попробовать делать вещи вручную.…
21 авг '12 в 09:58
0
ответов
PHP7 Symfony4 Phpdocumentor
Есть ли возможность использовать PhpDocumentor в разделе выше / под названием? Когда я пытаюсь установить его с помощью composer, он показывает мне: $ composer require --dev phpdocumentor/phpdocumentor dev-master ./composer.json has been updated Loa…
22 ноя '18 в 08:43
4
ответа
Как документировать массив [тип]?
Скажем, у меня есть такая функция: function theFunction() { $arr = array(); for ($i=0;$i<10;$i++) { $arr[] = new theObject($i); } return $arr; } Мне нужно документировать тип возврата функции. Я мог бы, конечно, просто использоватьarray, но это н…
11 июн '13 в 11:06
4
ответа
Есть ли хороший (автономный) класс анализатора PHPDoc или функция в PHP?
Я ищу какой-то метод преобразования докблока PHP (который используется для генерации документации такими инструментами, как Doxygen) в структуру, которую я могу проверить в PHP. Например, я хочу разобрать /** * Multiply two values * @CHECKME * * @au…
09 июн '10 в 22:06
3
ответа
Netbeans-esque ретроспективный инструмент автокомментирования /phpDocumentor (для Eclipse или автономный)
Есть ли что-нибудь похожее на инструмент автоматического комментирования Javadoc для PHP/phpDocumentor/Eclipse? В реализации NetBeans: Появится диалоговое окно, позволяющее вам пройти через всех членов вашего класса и ввести комментарии, которые доб…
05 авг '09 в 10:30
1
ответ
Как настроить и использовать phpDocumentor шаг за шагом
Как настроить и использовать phpDocumentor шаг за шагом? Я пытаюсь использовать композитор, так много запросов на установку. Может ли кто-нибудь дать мне представление о phpDocumentor установить и использовать в php. попробовал $ composer требовать …
12 мар '18 в 11:19
0
ответов
PhpStorm: игнорировать исключения времени выполнения / логики
В PhpStorm's настройки в Editor/Inspections/PHP/PHPDoc/Missing @throw tag(s) Есть два варианта, которые выбраны по умолчанию: Игнорировать исключения во время выполнения Игнорировать исключения логики ВОПРОС: Почему я хотел бы игнорировать эти конкр…
01 июл '15 в 19:53
0
ответов
PHPDoc: анонимная функция набора текста
Есть ли способ в PHPDoc, чтобы typehint вернуть значение анонимной функции? /** @var $snail callable */ /** @return Core|string */ $snail = function() { echo "whatever!"; }
09 авг '16 в 10:57
1
ответ
Используя phpDoc, я не получаю ошибок, но и результатов тоже нет
С несколькими файлами вроде этого: /** * Creates a new user account. * Collects posted form variables, escapes them, then passes them on to Storm. * @package User */ /** * Do includes. */ include_once('../Utilities.php'); include_once('../stormLibs/…
16 май '12 в 21:59
2
ответа
Показывать предупреждения phpDoc в Eclipse
Я использую Eclipse PDT и phpDoc. Я хотел бы, чтобы предупреждения phpDoc отображались в редакторе, как и другие инструменты "проверки". This would help the programmer team to create better documentation. Есть способ сделать это? Благодарю.
24 янв '11 в 11:29
1
ответ
Как создать документацию / документацию по API для Magento?
У меня установлен Magento, и я хотел знать, как сгенерировать полные документы API, такие как на http://docs.magentocommerce.com/, сгенерированные с использованием phpdoc. Есть ли файл конфигурации, включенный в Magento для phpdoc, который я могу ис…
28 июн '11 в 14:07
1
ответ
Как PHPDoc анонимная функция при передаче в качестве аргумента?
Как мне документировать анонимную функцию, когда она передается в качестве аргумента? Например: // Call my_function(), passing 2 arguments. my_function( 'foo', function() { // Body of the anon function I'd like to document. } ); Заранее спасибо.
30 дек '15 в 19:12
1
ответ
phpDoc @var для составного оператора не отображается правильно
У меня есть составное заявление в одном из моих классов, и, насколько я знаю, я следую за документами phpDoc здесь. Это просто соответствующая часть файла. У самого файла и класса есть docblocks. class contact { /** * @var PDO $pdo The PDO class for…
26 сен '14 в 20:37
3
ответа
Есть ли способ указать обязательный массив ключ / индекс через PHPDoc?
Если функция требует, чтобы входящий массив имел определенный ключ / индекс, есть ли красноречивый способ выразить это через комментарии, особенно PHPDoc? Например: /** * Just an example function * @param array $arr My Example Array */ public functi…
21 авг '12 в 14:40