phpdoc

Я нахожу тот, который доступен на веб-сайте, очень сложным для новичка в этом. Есть ли лучший учебник, который будет н ... ого, чтобы бросать в вас 3 длинных исходных файла php? Изменить: Неужели нет ничего другого, кроме руководства??? D:

Я часто даю объектам статические методы и свойства, которые не требуют инициализации объекта. Например: class SomeObje ... земпляр SomeObject, он подумает, что я могу получить доступ к обычным нестатическим методам и свойствам, чего я не могу.

В общем, свойства PHPDOC не требуют пояснений, но мне трудно их понять: @category - что это такое на самом деле? @package - может ли кто-нибудь привести мне примеры использования этого свойства?

У меня есть объекты со многими переменными, которые я объявляю и объясняю в комментариях. Я очень тщательно комментирую ... осто заявление от кого-то, кто знает PHPDoc, возможно ли это без необходимости перепроектировать большие части его кода.

В настоящее время мы находимся в начале нового проекта и хотели бы (на этот раз) прокомментировать как можно больше с с ... ьтатами. Можете ли вы поделиться своими лучшими практиками и приемами использования PHPDoc для комментариев в Eclipse?

На домашней странице http://www.phpdoc.org /, на http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutor ... $ pear install phpdoc/phpDocumentor-beta Какой предпочтительный способ установки phpDocumentor с использованием PEAR?

Если функция полагается на $_SESSION['some_var'], то заголовок закомментируйте, чтобы это было ясно. Как вы это делаете? Просто как текст, или что? Или даже @param?

Я использую NetBeans в качестве своей среды разработки php, и я видел теги @version в блоке документов, которые выглядя ... Есть ли у NetBeans способ автоматически обновлять это при каждой фиксации? Или я полностью упускаю смысл этого тега?

Можно ли намекнуть PhpStorm, что в коде ниже возвращаемое значение метода item() имеет тип DOMElement ( БЕЗ изменения ф ... ->getElementsByTagName('x'); if($list->length > 0) var_dump($list->item(0)->getAttribute('test'));

Я исхожу из строго типизированного языка программирования, который имеет тип с именем "ЛЮБОЙ". Поскольку PHP слабо св ... я говорит об этом? Мне также любопытно, только ли у меня есть эта проблема или есть другие, работающие подобным образом.

Есть ли способ пометить аргумент в подписи @метода как необязательный в PHPDoc? Что-то вроде этого: /* * @method bool alloc() alloc(int $filesize [, string &$result]) Allocates space for a file to be uploaded */

У меня есть следующий php-код <?php class A { public function foo() { } } /** * @var A $a */ $a-> ... один доступный метод foo. Нет такой строки, как $a = new A(); $a создается в другом месте и обрабатывается загрузчиком.

Я пытаюсь сделать все возможное, чтобы phpdocumentor разрешил мне использовать формат учебника DocBook в дополнение к д ... ый момент: phpdoc -o HTML:Smarty:HandS -d "/path/to/code/classes/", "/path/to/code/docs/tutorials/" -t /path/to/output

Итак, в папке PayPal у меня есть несколько классов для использования их API. Я хочу создать документацию о том, как п ... пке с именем ...? Как привести примеры, относящиеся к классу или пакету, например, шаг 1 бла-бла, шаг 2 бла-бла? спасибо!

Кажется, я не могу понять, как заставить теги PHPCocumentor2 @example работать правильно. Я пытаюсь проанализировать ... ; Несколько вложенных <code> и <pre> тегов, которые отображают что-то ужасное. Но это уже другой вопрос.

Существует класс, который я изменяю, написанный другим автором. Мне интересно, как правильно добавить мои изменения в ... лжить его? Должен ли я добавить к исходным комментариям PHPDoc или мне следует создать свой собственный отдельный блок?

Каков текущий статус использования пространств имен в типах данных phpdocs. Например: * @param string|Vendor\SomeClass $parameter

Я попытался сравнить показатели некоторых PHP-фреймворков с PHP-зависимостью и столкнулся с раздражающим и, вероятно, н ... "0.28114285714286"> ... </package> Теперь мой вопрос: В чем причина этого и как я могу это исправить?

Довольно простой вопрос: можно ли использовать вкладки внутри тегов phpDocumentor? Например: /** * @param string @so ... ome_var и описанием есть вкладка Не нашел ничего против вкладок (кроме объявления списка), но я просто хочу убедиться.

У меня установлен Magento, и я хотел знать, как создать полные документы API, такие как на http://docs.magentocommerce. ... pdoc. Есть ли файл конфигурации, включенный в Magento для phpdoc, который я могу использовать для создания документации?