Вопросы по теме 'phpdoc'
Как использовать phpDoc с перегруженными методами?
Допустим, у меня есть класс PHP с именем Color , его конструктор принимает различные параметры.
// hex color
$myColor = new Color('#FF008C');
// rgb channels
$myColor = new Color(253,15,82);
// array of rgb channels
$myColor = new...
4310 просмотров
schedule
26.05.2023
Стандарт phpdoc для установки значения по умолчанию для необязательного параметра?
Пример:
/**
* This function will determine whether or not one string starts with another string.
* @param string $haystack <p>The string that needs to be checked.</p>
* @param string $needle <p>The string that is being checked...
11858 просмотров
schedule
20.09.2022
Можно ли использовать phpDocumentor для разбора тегов DocBlock?
Я хочу использовать классы phpDocumentor для разбора собственной документации PHP и работы с результатами. Я могу сделать это вручную, но я уверен, что можно использовать phpDocumentor.
Проблема в том, что я не могу найти никакой документации по...
324 просмотров
schedule
27.06.2023
Подсказка типа переменной в Netbeans (PHP)
Просто любопытно, есть ли в netbeans способ давать подсказки типа для обычных переменных, чтобы intellisense уловил это. Я знаю, что вы можете сделать это для свойств класса, параметров функций, возвращаемых типов и т. д., но я не могу понять, как...
46259 просмотров
schedule
24.12.2023
Внешняя документация по PHP, без DocBook
Мне нужна система документации для проекта PHP, и я хотел, чтобы она могла интегрировать внешнюю документацию (варианты использования, объем проекта и т. д.) с документацией, созданной из комментариев к коду. Кажется, что phpDocumentor имеет именно...
839 просмотров
schedule
23.08.2022
Как задокументировать метод, который изменяет защищенный атрибут с помощью phpdoc?
Как лучше всего задокументировать метод, который изменяет защищенный атрибут с помощью phpdoc?
Например, как правильно документировать приведенный ниже метод setVar()?
class Test {
protected $variables = array();
public function...
406 просмотров
schedule
14.03.2023
PhpDocumentor как избежать * перед каждой новой строкой комментария
Согласно PhpDocumntor, каждый блок комментариев для преобразования в действительную часть документации должен быть инкапсулирован следующим образом:
/**
* This function is used blah, blah, blah
* line 2
* line 2
* ...
*/
function MyFunc($string)...
180 просмотров
schedule
21.07.2022
PhpDocumentor умер?
Или это только в "законченном" состоянии? Я использовал PHPDoc в течение многих лет во всех своих PHP-проектах, но недавно я заметил, что последний пост на веб-сайте PHPDoc был датирован 2008 годом. Поэтому мне интересно, не пора ли рассмотреть...
4146 просмотров
schedule
23.10.2022
PHPDoc и __callStatic
tl;dr
Как правильно аннотировать (в PHPDoc) функции, реализованные через __callStatic ? Что еще более важно: есть ли способ заставить NetBeans и PHPStorm понять, что это статические методы?
Мотивация
Если вам нужна более широкая картина,...
6514 просмотров
schedule
24.01.2023
Создать документацию для нескольких классов с одинаковым именем?
У меня есть веб-приложение, в котором есть несколько файлов «Контроллер», каждый из которых определяет класс с именем «Контроллер». Существует сценарий маршрутизации, который включает только нужный файл в зависимости от запроса страницы, а затем...
480 просмотров
schedule
20.07.2022
как мне задокументировать использование GET или POST в методе контроллера?
Я ищу лучший способ документирования моих методов контроллера в php. Мне было интересно, как я должен документировать свои требования POST и GET (здесь я использовал REQUEST , чтобы показать, что мне это нужно для обоих способов).
см. этот...
193 просмотров
schedule
22.04.2023
PHP docBlock @return className
Как создать PHP DocBlock с указанием @return, в котором указано возвращение класса. На данный момент это довольно просто, выполнив
/**
* This returns an object of the "User" class
* @return User
*/
public function getUser() { return...
2629 просмотров
schedule
30.03.2023
PHPDoc: Можно ли ссылаться на описания свойств объекта из docblock фабричного метода?
Если я использую фабричный метод для создания экземпляров объектов, то можно ли ссылаться на описания докблоков свойств класса для создаваемых объектов?
Я ловлю себя на том, что просматриваю классы, чтобы напомнить мне, какие параметры задавать...
776 просмотров
schedule
07.12.2022
Как указать массив объектов в PhpDoc
Я использую PhpDocumentor2 для создания документации. Я искал эту тему, но не могу найти для нее конкретного правила. Например, у меня есть класс с именем AddressField, и я хочу указать мои $ addressFields как массив объектов AddressField.
/**
*...
12858 просмотров
schedule
11.05.2023
PHPDoc на OSX через PEAR
Я использую ОС 10.8.2 (Горный лев).
Я сделал новую установку PEAR, как говорится в этом блоге:
http://clickontyler.com/blog/2008/01/how-to-install-pear-in-mac-os-x-leopard/
Поэтому я установил include_path в моем файле php.ini на...
933 просмотров
schedule
01.05.2022
phpDocumentor 2.0 DocBlock на уровне страницы — где это?
У меня есть набор классов, каждый класс в своем файле. Я добавил соответствующие DocBlocks, чтобы не получать ошибок или предупреждений при создании документации. Вот очень упрощенный пример:
<?php
/**
* Page level description.
*/
/**
*...
760 просмотров
schedule
20.05.2022
Использование @since в PHP-коде
Я использую комментарий @since в своем PHP-коде. У меня есть вопрос о его использовании, хотя. Скажем, у меня есть функция, выполняющая определенную задачу, и она реализована в версии 1.0.
Итак, в настоящее время у меня есть @since 1.0.
Теперь...
3244 просмотров
schedule
28.10.2022
Какие причины и обстоятельства следует предпочесть javadoc / phpdoc обычным комментариям?
Какие причины и обстоятельства следует предпочесть javadoc / phpdoc обычным комментариям? Я знаю, в чем разница в синтаксисе, но зачем использовать то или иное. Это в основном семантическое или есть другие причины, по которым я должен использовать...
1192 просмотров
schedule
21.11.2022
Что означает отсутствие краткого описания свойства из phpDoc?
Я получаю эту критическую ошибку при запуске phpDoc в моем файле класса:
No short description for property $id.
Это соответствующий код:
/** @type int The user's id. */
private $id = 0;
Я считаю, что именно так используется в...
267 просмотров
schedule
14.09.2022
Синтаксис закрытия в PHPDoc
Я не могу найти документацию по типу Closure в PHPDoc. Итак, мой вопрос: как определить параметр параметров, отправленных на закрытие, и его возвращаемое значение?
Пример:
Как мне описать, что «обратный вызов» получит «MyCustomClass», число и...
5090 просмотров
schedule
01.06.2022
