Есть ли какие-либо причины, чтобы моя IDE (фактически PHPStorm) понимала это: $student->setName('Marco'); setName() экземпляр Student , не переопределяя setName() в подклассе (только для добавления комментариев PHPDoc)? class Person { private $name; /** * @param string $name * @return Person */ public function setName($name) { $this->name = $name; return $this; } } class Student extends Person […]
В настоящее время мы находимся в начале нового проекта и хотели бы (на этот раз) комментировать как можно больше с самого начала, чтобы помочь в будущем развитии. Я попытался выяснить, какие лучшие методы использования phpDoc в Eclipse, но с довольно тонкими результатами. Можете ли вы поделиться своими рекомендациями и трюками с использованием phpDoc для комментариев […]
Как указать, что этот метод является частью интерфейса с PHPDoc? Например: /** * @implements BarInterface */ class Foo implements BarInterface { /** * @thisMethodIsHereBecauseItIsAPartOf("BarInterface") */ public function doBar() { } } Есть ли что-нибудь подходящее для замены @thisMethodIsHereBecauseItIsAPartOf("BarInterface") с помощью?
Я установил phpDoc на наш сервер, настроил и т. Д. Он корректно обрабатывает документацию. Мы используем шаблон «Отзывчивый», однако эта ошибка возникает независимо от используемого шаблона. В разделе «Ошибки» каждый сканируемый файл имеет следующую ошибку: Type Line Description error 0 No summary was found for this file Я для этого исчерпывающе искал и не могу […]
Вопрос довольно прост – как мне отличать phpdoc для интерфейса и интерфейса реализации класса? Должны ли они быть одинаковыми или, может быть, интерфейсная документация должна быть как можно более общей, а класс, реализующий этот интерфейс более конкретным? Я включаю один метод phpDoc из моего реального кода: Мой интерфейс: interface CacheInterface { /** * Adds data […]
Как мы должны документировать (с phpDocumentor ) константы, определенные с помощью define () в PHP? Я ничего не нашел в документах, но нашел следующий пример (который я не вижу его использование) в sample2.php: /**#@+ * Constants */ /** * first constant */ define('testing', 6); /** * second constant */ define('anotherconstant', strlen('hello')); Кто-нибудь может сказать мне, […]
Представьте себе следующую гипотетическую структуру классов, а не слишком необычный сценарий, когда все намеки PHPdoc настроены правильно: class BaseFilter { /** …base methods… */ } class TextFilter extends BaseFilter { public function setMinLength($len) { /** …irrelevant */ } } class SomethingWithFilters { /** * @param BaseFilter $filter A valid filter to be added. * @return […]
Я хочу начать использовать phpDocumentor, и ручная установка продолжает выдавать ошибку обо мне, не установив detect_unicode = Off в моем php.ini в Terminal. Когда я добавляю его в свой php.ini, он не берет, и я получаю ту же проблему при запуске установки. Кажется, что у этой проблемы нет, и для жизни я не могу понять. […]
Как установить переменное число параметров? Я пишу приложение в PHP и JavaScript. В настоящее время у меня (в JavaScript): /** * Description * @param {String} description */ function fn() { // arguments holds all strings. } Итак, как мне doc n-число строковых параметров?
Что касается этого поста: В PHPStorm, как я могу сделать работу типа намека, когда у меня есть метод суперкласса, который возвращает другой тип из каждого подкласса , это один из граничного случая в намеке типа PHPStorm. Пожалуйста, попробуйте следовать за мной – я сделаю все возможное, чтобы быть максимально ясным: Итак, у меня есть этот […]