phpdoc

Таким образом, в PHPDoc можно указать @var над объявлением переменной-члена, чтобы указать ее тип. Затем IDE, например. ... я представляет собой массив SomeObjs? @var массива недостаточно, и @var array(SomeObj), например, не кажется допустимым.

Просто быстрый вопрос: я видел, что некоторые функции PHP прокомментированы вверху, используя неизвестный мне формат: ... не будет включать символ @ в свой поиск. Что это за формат комментариев и где я могу найти некоторую информацию о нем?

Действительно ли необходимо делать что-то подобное: /** * ... * * @return void */ У меня есть довольно много ... ействительно излишним помещать что-то подобное в комментарий. Будет ли считаться дурным тоном оставить это без внимания?

Просто любопытно, есть ли в netbeans способ давать подсказки о типе для обычных переменных, чтобы intellisense их улавл ... е после этого используется $SomeService, netbeans предоставит все доступные методы, определенные в классе Some_Service.

У меня есть этот код: /** * Days to parse * @var int */ const DAYS_TO_PARSE = 10; ... Я не думаю, что использование @var правильно для константы, и я не вижу никакого тега @constant PHPDoc. Как правильно это сделать?

У меня есть метод, который возвращает текущий объект, как мне это задокументировать? /** * set something * * @retur ... Something(){ // ... return $this; } Или я должен сделать @return self или @return Current_Class_Name?

Я изо всех сил пытаюсь написать понятную и легкую для понимания документацию, описывающую многодеревянную структуру для ... ан. Кроме того, я не уверен, что вышесказанное четко объясняет структуру массива. Существует ли альтернативный подход?

У меня есть метод, который извлекает измененное поперечное дерево дерева предварительного заказа из базы данных и фильт ... правильно. Кроме того, мы будем признательны за любые другие замечания по качеству (или его отсутствию) в этом коде:)

У меня есть несколько законченных, старых PHP-проектов с большим количеством включений, которые я хотел бы документиров ... едставить, что инструмент C/Java может обрабатывать файлы PHP после некоторой настройки. Спасибо за ваш большой вклад!

Каков наиболее полезный/наиболее стандартный/наименее неожиданный способ последовательного написания блоков комментарие ... Я хочу попытаться избежать, насколько это возможно, повторения между блоками комментариев класса, конструктора и файла.

Из того, что я исследовал, я, похоже, не могу найти правильный метод форматирования многострочной строки phpdoc @param. ... string; } Было бы это правильно, или вы бы не добавляли отступы, или просто сохранили бы все в одной длинной строке?

Или это просто "законченное" состояние? Я использовал PHPDoc в течение многих лет во всех своих PHP-проектах, но неда ... ОВЛЕНИЕ: Получается, что DocBlox - это PHPDocumentor2, замаскированный/переименованный. http://www.docblox-project.org/

Я использую Eclipse PDT и хочу аннотировать локальную переменную с помощью Phpdoc. Все, что я вижу, это то, что я мог ... локальной переменной? Как я могу сделать что-то подобное? function foo(){ /** @var Stock $a */ $a->save(); }

Допустим, у меня есть класс с таким методом: /* * * Loads the user from username. * * @param string $username The ... $user === null) { throw new userNotFoundException(); } return $user } Номер 3 Не делай что-нибудь.

Использует ли кто-нибудь что-нибудь еще для документирования своего кода PHP, кроме PHPDoc? Существуют ли какие-либо инструменты, которые читают тот же синтаксис документации, но дают более богатый вывод?

Каков правильный синтаксис для @inheritdoc в phpDocumentor, если я просто хочу унаследовать всю документацию от родител ... rm, похоже, поддерживает их все, но, возможно, у меня возникнут проблемы с созданием документов с некоторым синтаксисом?

Как мне документировать константы классов для PHPDoc? Я прочитал руководство, но ничего не могу найти о них.

Tl;др Как правильно аннотировать (в PHPDoc) функции, реализованные с помощью __callStatic? Более важно: есть ли способ ... основная цель - ознакомить IDE с этими функциями; наличие правильного PHPDoc на самом деле не является необходимостью.

Я на мгновение ищу способ изменить имя и почту, используемые PHPDoc в PhpStorm, когда вы используете "автозаполнение", ... которые я использую в своем проекте. Я не нахожу места для изменения значений по умолчанию... У кого-нибудь есть идея?

В моем проекте есть определенные каталоги и определенные php-файлы, которые очень велики по размеру, из-за чего моя сбо ... будут эти большие файлы. Вопрос 4- Могу ли я настроить проверку таким образом, чтобы эти файлы не проверялись выйти?