Что является наиболее полезным / наиболее стандартным / наименее удивительным способом последовательного написания блоков комментариев для конструкторов и классов и файлов, содержащих только один класс? Блоки комментариев для классов, а не конструкторы Блоки комментариев для конструкторов, а не классов Блоки комментариев для обоих конструкторов и классов -> В таком случае какие детали должны идти в […]
Возможный дубликат: Тип PHPDoc намекает на массив объектов? Я использую PhpDocumentor2 для создания документации. Я искал эту тему, но я не могу найти для нее определенное правило. Для примера у меня есть класс, имя которого является AddressField, и я хочу указать my $ addressFields как массив объектов AddressField. /** * @var AddressField[] */ private $addressFields;
Возможный дубликат: PHPDoc для массивов аргументов переменной длины Всякий раз, когда я $_SERVER[''] и нажимаю Ctrl + Space, он дает мне список возможных индексов. Как я могу создать массив, который я создал?
Есть ли способ документировать константу, определенную с помощью define() ? @var на самом деле не имеет смысла. Единственное, о чем я могу думать, это опустить тег и просто написать описание в комментарии PHPdoc.
Мне очень нравится работать в Notepad ++, но я еще не нашел плагин для автоматического создания комментариев в стиле PHPDoc. Другие PHP IDE (Eclipse, NetBeans, ZendStudio) включают эту функцию, и это очень удобно. В принципе, я хочу, если на строке выше определения функции или определения класса я печатаю: /** Он автоматически заполняет формат PHPdoc (что-то […]
Из-за простоты обслуживания и автоматического завершения класса IDE и подсказок участников я использовал PHPDoc в своем проекте. Учитывая этот пример класс: class my_class { public $id; public $name; public $number; public function __construct() { //Do something } public function Rename($name) { $this->name = $name; } } Я бы предпочел документировать все свойства ( $id , […]
Я пытаюсь запустить PHPDocumentor на моей настройке WAMPServer. Он работает нормально, но я хотел бы исключить определенные каталоги, такие как \ sqlbuddy \, которые не содержат мой собственный код. Как ни странно, PHPDocumentor, похоже, игнорирует мой переключатель -ignore. Я пробовал несколько способов выразить одно и то же, но с тем же результатом. Ниже приведена команда, […]
Каков рекомендуемый метод документирования метода класса, который принимает переменное количество аргументов? Может, что-то вроде этого? <?php class Foo { /** * Calculates the sum of all the arguments. * * @param mixed [$arg1, $arg2, …] * * @return float the calculated sum */ public static function sum() { return array_sum(func_get_args()); } } Примечание. Как правило, […]
У меня есть этот код: /** * Days to parse * @var int */ const DAYS_TO_PARSE = 10; … Я не думаю, что использование @var является правильным для константы, и я не вижу никакого @constant тега PHPDoc. Каков правильный способ сделать это?
Я не могу найти документацию по типу Closure в PHPDoc. Итак, мой вопрос заключается в том, как определить параметр параметров, присланных в закрытие и его возвращаемое значение? Пример: Как я могу описать, что «обратный вызов» получит «MyCustomClass», Number и String и вернет «MyOtherCustomClass»? /** * @param MyCustomClass $cls * @param Closure $callback this isn't really […]