Описание тега docblocks
A DocBlock is a specially formatted PHP comment which allows external document generators to generate documentation of APIs and helps some IDEs to interpret variable types, provide improved code completion, type hinting and debugging.
2
ответа
Как документировать магические (_call и _callStatic) методы для IDE
После многих счастливых лет написания кода в notepad++ и возвышенном, мне посоветовали попробовать PHP IDE. Я пробую phpStorm, и это кажется хорошим. Завершение кода и документация - отличная возможность, но у меня не получается, когда используются …
26 мар '13 в 09:54
0
ответов
PhpStorm: игнорировать исключения времени выполнения / логики
В PhpStorm's настройки в Editor/Inspections/PHP/PHPDoc/Missing @throw tag(s) Есть два варианта, которые выбраны по умолчанию: Игнорировать исключения во время выполнения Игнорировать исключения логики ВОПРОС: Почему я хотел бы игнорировать эти конкр…
01 июл '15 в 19:53
1
ответ
Удалить квадратные скобки [] из комментария DocBlockr
Мне нравится плагин DocBlockr для возвышенного текста, но я бы хотел, чтобы мои комментарии были немного другими. Нормальный внешний вид: И как бы я хотел, чтобы они появились: Итак type, description без [] квадратные скобки есть в любом случае дела…
07 авг '15 в 17:53
1
ответ
Использование DocBlocks - как указать, что функция возвращает значение только в некоторых условиях?
У меня есть эта функция: public function createController() { $valid_controller = class_exists($this->controllerClass) && in_array("BaseController", class_parents($this->controllerClass)); if($valid_controller) { return new $this->c…
02 ноя '15 в 09:35
1
ответ
phpdoc как документировать @turn для успеха и неудачи
Я пытаюсь правильно сохранить документы на своем php rest server, поэтому мне было интересно, как мы документируем, что возвращаемое значение может быть одним из 2? /** * send email to a user that contain reset data * it also create reset token, so …
21 июн '17 в 10:51
1
ответ
Sublime Text 2 Поддержка формата комментариев
Может ли Sublime Text 2 поддерживать такой комментарий? /** @param @return */ Любой плагин может сделать это в PHP или же JS или же CSS?(Я устанавливаю плагин:DocBlockr уже. Но это не может работать в Windows7 сейчас) Дополнительный пост на сегменте…
17 авг '13 в 17:13
0
ответов
Лучшая практика использования @package и @since в разветвленном проекте
Мой проект использует FoundationPress, начальную тему WordPress. Я использую Github и обновляю свой проект из родительского репозитория upstream remote когда сообщество улучшает код. Кстати, я программировал долгое время, но почти всегда один, и я о…
10 янв '19 в 18:44
1
ответ
Не удается заставить DocBlox работать с Netbeans
Я пытаюсь заставить Netbeans для Mac интегрироваться с DocBlox для генерации документации. Я следовал инструкциям на сайте docblox по интеграции с NetBeans, но когда я на самом деле пытаюсь сгенерировать документацию, я не получаю вывод, и в окне вы…
02 янв '12 в 11:29
1
ответ
В DocBlocks я должен всегда использовать однострочное обозначение при написании одной строки?
Допустим, у меня есть одна строка summaryДолжен ли я исправить это так: /** summary */ или я могу написать это так: /** * summary */ Я предпочитаю второй вариант, но нужно ли использовать первый вариант?
22 окт '15 в 18:45
1
ответ
Переопределить PHP-докблок / аннотацию метода без перегрузки (автозаполнение PhpStorm)
Это вопрос о поведении автозаполнения в PhpStorm (и, возможно, других IDE) в сочетании с докблоками PHP. У меня есть группы классов в моем приложении. Во-первых, существуют отдельные классы для различных продуктов (CarProduct, FoodProduct и т. Д.), …
30 мар '17 в 08:16
1
ответ
PHP динамические DocBlocks уровня страницы
Мне было интересно, есть ли способ взаимодействия с DocBlocks уровня страницы. Мой вопрос более конкретно касается разработки плагинов WordPress, но этот вопрос возник также в среде без WordPress. Причина в основном заключается в возможности легко м…
23 июн '12 в 02:59
1
ответ
PHPDocumentor - что не так с моим DocBlock?
Я добавляю некоторые комментарии в какой-то унаследованный код и натолкнулся на небольшую проблему с PHPDocumentor. Вот пример: /** * Constructs the Widget object * * Basic constructor for the widget object. * Another line of pointless explanation, …
30 окт '14 в 22:55
2
ответа
Правильно ли обозначить автора и имя проекта в файлах PHP?
Я просто хотел узнать, каков наиболее приемлемый способ кредитования себя, и описать весь пакет (желательно) в начале документа, чтобы другие лица, просматривающие код, имели ссылку? Я хотел бы знать ответ из-за проекта PHP, над которым я работаю, и…
06 авг '13 в 09:40
1
ответ
Как свернуть / развернуть все блоки комментариев в файле в PhpStorm?
В PhpStorm, как быстро свернуть или развернуть все блоки комментариев (doc) в файле? В документации здесь говорится: Складывание и расширение блоков кода работает для целых классов, внутренних и анонимные классы, тела методов, списки импорта, коммен…
05 фев '15 в 21:52
1
ответ
PhpStorm генерирует пустой документ-комментарий
PhpStorm генерирует пустые комментарии к документам: "/** + пробел" или "alt + insert" верните это: /** * */ public function getSomething(array $data): string { return implode($data); } Генерация сеттеров или геттеров тоже не работают. Проверьте, чт…
31 окт '17 в 16:03
1
ответ
Добавление phpdoc в новые файлы
Я ищу способ добавить некоторые docblocks в новый файл.php, чтобы я мог добавить описание, имя пакета, автора и т. д. в новый файл. Я искал пару дней, и я не вижу никаких результатов о том, как добавить только 1 .php файл, может быть, консольную ком…
03 апр '11 в 15:49
2
ответа
Когда я должен использовать NULL в подсказках типа PHPDoc и docblocks?
Я не понимаю, когда использовать null как тип при описании переменных с помощью PHPDoc. Должны ли подсказки типа описывать надежды и ожидания для внешних вызывающих абонентов, чтобы предвидеть и соблюдать, или они должны документировать все возможны…
01 окт '12 в 02:39
2
ответа
Наследование типов классов DocBlock
Хотя этот вопрос касается DocBlocks в целом, мой пример использования касается PHP. Рассмотрим следующий код PHP: <?php class ParentClass { /** * Says 'hi' to the world. * @return ParentClass Returns itself for chaining. */ public function say_hi…
11 сен '12 в 21:07
0
ответов
Как включить докблок для шаблона класса?
Допустим, у вас есть следующий класс? public abstract class Foo<T> { } Как выглядит докблок для этого класса? В частности, я хочу включить примечание о том, что T на самом деле делает / есть, похоже на @param аргумента функции.
13 дек '17 в 18:04
4
ответа
Генерировать аннотированные doctrine2 entites из схемы БД
Можно ли сгенерировать сущности Doctrine 2 с соответствующими аннотациями docblock из существующей схемы базы данных?
31 окт '10 в 22:59