Вопросы по теме 'phpdoc'

PhpDocumentor, установленный через PEAR на OSX, не работает — отсутствуют файлы?
Я в основном новичок в PEAR (и PhpDocumentor); Я установил PhpDocumentor с помощью PEAR CLI, и все, казалось, шло нормально... пока я не начал его использовать, после чего я получил следующую ошибку: Warning:...
4499 просмотров
schedule 05.10.2022

Разбор комментариев PHP Doc в структуру данных
Я использую Reflection API в PHP для извлечения строки DocComment (PHPDoc) из метода. $r = new ReflectionMethod($object); $comment = $r->getDocComment(); Это вернет строку, которая выглядит примерно так (в зависимости от того, насколько...
14302 просмотров
schedule 23.04.2024

php / phpDoc — экземпляр @return этого класса?
Как пометить метод как «возвращающий экземпляр текущего класса» в моем phpDoc? В следующем примере моя IDE (Netbeans) увидит, что setSomething всегда возвращает объект foo . Но это неверно, если я расширяю объект — он вернет $this , что во...
8729 просмотров
schedule 18.01.2023

Комментарии PHPDoc в Notepad++?
Мне очень нравится работать в Notepad++, но я еще не нашел плагин для автоматического создания комментариев в стиле PHPDoc. Другие PHP IDE (Eclipse, NetBeans, ZendStudio) включают эту функцию, и это очень удобно. В основном я хочу, чтобы в строке...
9483 просмотров
schedule 11.09.2022

Могу ли я дважды использовать @subpackage для phpDocumentor?
Например, у меня есть проект под названием «myproj» и подпакет под названием «utils», и в этом подпакете снова есть подпакет под названием «отладка». Могу я сделать что-то подобное:? /** * @package myproj * @subpackage utils * @subpackage...
384 просмотров
schedule 09.03.2022

Документирование приватных методов
Можно ли вытащить документацию для приватных методов с помощью phpDocumentor? Я понимаю, что обычно это не делается, но в моем текущем проекте это было бы полезно.
1004 просмотров
schedule 18.01.2023

Способ phpDoc перечислить, какие внешние константы использует класс?
Есть ли лучший способ документирования того, какие внешние константы используются классом PHP? Например, у меня есть класс, который записывает данные в текстовый файл. Этот класс создает файл и помещает его в каталог. Путь к этому каталогу —...
926 просмотров
schedule 08.10.2022

Странная ошибка PhpDocumentor: по ссылке должны передаваться только переменные
Я использую PhpDocumentor (1.4.4) и NetBeans (7.1). Когда я генерирую документацию php, я получаю сообщение об ошибке/предупреждении в верхней части документации (и в документации в некоторых местах тоже): "Strict Standards: Only variables should...
1505 просмотров
schedule 06.05.2024

Почему я получаю предупреждение PHPDoc в PhpStorm по этому коду
Я не могу понять, почему PhpStorm выдает мне следующее предупреждение PHPDoc comment does not match function or method signature по поводу этого метода: /** * Create a new instance of the class * @param string $classname Class to instantiate...
8969 просмотров
schedule 25.04.2024

Можете ли вы автоматически поместить код метода в его DockBlock в phpDocumentor 2?
Я установил phpDocumentor 2 и хочу включить исходный код для каждого метода в сгенерированную документацию. Однако я заметил, что встроенный тег @source , похоже, не подхватывается, и кажется, что на него есть только ссылка в документация...
914 просмотров
schedule 29.11.2022

Комментирование операторов if для phpdocumentor2
Я нахожусь в процессе документирования проекта PHP с использованием PHPDocumentor2. Как ни странно, документация PHPDoc не слишком детализирована. Я полностью понимаю, как комментировать файлы, классы, функции и переменные, однако, если переменная...
192 просмотров
schedule 17.06.2022

Пост-параметр в PHPDoc
мне нужна помощь с этим, когда я пишу PHPDoc, я не знаю, как я могу указать переменные публикации для метода. в этом коде: /** * Show Quarter Base Hour * GET: Show select Menu | POST: Get Quarter Base Hour View * * * @return...
836 просмотров
schedule 03.07.2023

использовать phpDocumentor на symfony2
Я установил новый проект Symfony 2.4, а также установил phpDocumentor с помощью composer.phar, выполнив следующие действия: 1- Добавление: "require-dev": { "phpdocumentor/phpdocumentor": "2.*" } в My composer.json 2- Выполнение:...
4489 просмотров
schedule 14.11.2023

Phpdoc Для этого файла не найдено резюме
Я установил phpDoc на наш сервер, настроил и т. д. Он правильно создает документацию. Мы используем адаптивный шаблон, однако эта ошибка возникает независимо от используемого шаблона. В разделе «Ошибки» каждый отсканированный файл имеет следующую...
17038 просмотров
schedule 09.02.2023

В phpdoc определите свойства класса в отдельном файле
Я использую фреймворк, который позволяет добавлять новые компоненты в базовый класс фреймворка. Есть ли способ задокументировать эти новые методы без изменения файлов фреймворков, чтобы я мог перейти к методу в своей среде IDE.
592 просмотров
schedule 22.05.2022

Отключить PhpDoc по умолчанию в диалоговом окне рефакторинга метода извлечения PhpStorm
Я искал настройки PhpStorm, документацию и Google безрезультатно. Есть ли способ отключить по умолчанию параметр «Создать PhpDoc» в диалоговом окне «Извлечь метод» PhpStorm?
798 просмотров
schedule 20.07.2023

Как динамически изменять поле @version из phpdocumentor
Я использую теги phpdocumentor для документирования классов и функций моих php-кодов, как показано ниже. /** * Module for Car * @category Vehicle * @version 2.0 * @since 1.0 * @link http://api.abc.example.com/v2.0/docs/#!/car */ Мой...
120 просмотров
schedule 15.10.2022

Как задокументировать использование метода при вызове в абстрактной форме?
В устаревшем проекте я был сбит с толку, когда безуспешно пытался найти использование метода в phpstorm. /** * @param SomeEntity[] $someEntity * * @return bool */ protected function warmupSomeEntity(array $brandUniverses) { // I want to...
79 просмотров
schedule 15.08.2022

Сохранить порядок функций в phpdoc
Я запускаю phpdoc в своем проекте, и есть файл (единственный значимый файл), в котором порядок методов важен для группировки методов. Как я могу иметь тот же порядок функций в сгенерированной документации, что и в исходном файле? На самом деле,...
256 просмотров
schedule 29.01.2023

PHPdoc не обнаруживает объект (и другие свойства)
Я пытаюсь создать PHP-документ для своего проекта с правильной информацией. Я пытаюсь создать информацию для объектов, созданных внутри метода класса. К сожалению, PHPdoc не распознает мой объект внутри моей функции. Код выглядит следующим...
142 просмотров
schedule 02.03.2024