У меня есть открытый метод для класса, и я хотел бы документировать доступные значения строк, которые метод может принять. Будет ли это приемлемо: /** * Set size of photos * * @param string $size can be one of these options: url_sq, url_t, url_s, url_m, url_o * @return void */ public function setSize($size){ $this->_size = $size; […]
Я в основном новичок в PEAR (и PhpDocumentor); Я установил PhpDocumentor, используя PEAR CLI, и все, казалось, все в порядке … пока я не пошел использовать его, после чего я получил следующую ошибку: Warning: require(PhpDocumentor/phpDocumentor/phpdoc.inc): failed to open stream: No such file or directory in /usr/local/bin/phpdoc on line 40 Fatal error: require(): Failed opening required […]
Я использую среду PHPStorm и сталкиваюсь с проблемами при запуске проверки кода. У меня есть метод, который возвращает коллекцию объектов. Сама Collection – это объект, который имеет свои собственные методы и реализует интерфейс Traversable : class Repository { public function findByCustomer(Customer $user) { // … return new Collection($orders); } } Если я findByUser() для возврата […]
Есть ли способ добавить пользовательскую аннотацию phpdoc для Eclipse PDT? Например, я хочу видеть @depends (для PHPUnit) в списке автозаполнения для комментариев, но теперь я вижу только стандартные аннотации (например, @deprecated ). Заранее спасибо.
Я пытаюсь использовать phpDocumentor (в первый раз, я понятия не имею, что я делаю). На самом деле, я хочу использовать его только с SublimeText 2 и этим плагином. Можете ли вы повести меня шаг за шагом, что я должен сделать, чтобы заставить его работать? Вот что я сделал сейчас: (я использую Windows 7) Скачал phpDocumentor […]
Я развиваюсь с помощью Eclipse + PDT. Я добавляю комментарии phpdoc в свой код, но на самом деле никогда не создавал результирующую документацию в Eclipse. Как мне это сделать – есть ли какая-то функциональность в Eclipse, или генерация doc должна выполняться извне?
Есть ли что-то похожее на инструмент автоматического комментария javaadoc для netbean для PHP / phpDocumentor / Eclipse? В реализации netbeans: Откроется диалоговое окно и позволяет запускать все члены вашего класса и вводить комментарии, которые добавляются в исходный файл. Он даже проверяет, что нет параметров, которые вы не учитывали, поэтому вы можете быть уверены, что ваши […]
Некоторые из новых функций PHP 5.3, включая пространства имен и анонимные функции, несовместимы с PHPDocumentor, даже с последней версией. Например, он просто вызывает ошибку, когда встречается «функция без имени», т. Е. Закрытие. Итак, есть ли какие-либо другие инструменты с открытым исходным кодом, которые генерируют документацию API (желательно в HTML) из комментариев в стиле Javadoc в […]
Просто быстрый вопрос: я видел, что некоторые функции PHP прокомментированы вверху, используя неизвестный мне формат: /** * * Convert an object to an array * * @param object $object The object to convert * @return array * */ Моя IDE дает мне выпадающий список для таких вещей, как @param и @return, поэтому он должен быть […]
Я использую Reflection API в PHP, чтобы вытащить строку DocComment (PHPDoc) из метода $r = new ReflectionMethod($object); $comment = $r->getDocComment(); Это вернет строку, которая выглядит примерно так (в зависимости от того, насколько хорошо документирован метод) /** * Does this great things * * @param string $thing * @return Some_Great_Thing */ Существуют ли встроенные методы или […]