Кто-нибудь использует что-либо еще для документирования своего PHP кода, чем PHPDoc? Есть ли инструменты, которые читают один и тот же синтаксис документации, но дают более богатый результат?
Существует ли синтаксис для документирования функций, которые принимают один конфигурационный массив, а не отдельные параметры? Я имею в виду библиотеки CodeIgniter, которые используют механизм, подобный этому: <?php // // Library definition // class MyLibrary { var $foo; var $bar; var $baz; // … and many more vars… /* Following is how CodeIgniter documents their built-in […]
В PHP-проекте, даже если логика контроллера контроллера используется для основного приложения, может быть много автономных скриптов, фрагментов ajax и т. Д. Существует ли стандартизованный способ – либо PHPDoc, либо что-то еще – определить в первом блоке комментариев скрипта параметры GET и / или POST, которые скрипт примет / потребует и какого типа они есть? Я […]
который является правильным способом документировать константы класса для phpDoc? Я прочитал руководство, но я ничего не могу найти о них
Надеюсь, кто-то здесь знает что-то или об этом. Короткий вопрос Я запускаю ошибку, используя phpdoc в командной строке, установленную через грушу на PHP 7.0.2. Ошибка: #> phpdoc PHP Fatal error: Uncaught Doctrine\Common\Annotations\AnnotationException: You have to enable opcache.load_comments=1 or zend_optimizerplus.load_comments=1. in /usr/local/php5-7.0.2-20160108-102134/lib/php/phpDocumentor/vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/AnnotationException.php:193 Как исправить эту ошибку? Детали Opcache включен, и opcache.load_comments=1 находится в моем файле opcache.ini, […]
Действительно ли нужно сделать что-то вроде этого: /** * … * * @return void */ У меня есть довольно много методов, которые не имеют возвращаемого значения, и кажется, что излишне добавлять в комментарий что-то вроде этого. Будет ли считаться плохой формой, чтобы оставить это?
Есть ли стандарт кодирования PHPCS, который бы проверял, что в @param правильные аннотации ( @param , @return , @throws и т. Д.), Включая правильный интервал между ними?
Иногда в моем коде мне нравится комментировать блок кода для временного использования / ссылки и т. Д., Например: /* blah */ Но это незначительная досада, что, если я тогда захочу пойти и вставить строку внутри этого блока, когда я нажму «enter», он автоматически поместит * на следующую строку, как если бы я делал DocBlock. Это […]
Я не знаю, является ли это поведением по умолчанию или нет, но мне кажется странным. Я установил WAMP-сервер v2.2e с нуля с помощью PHP 5.4.3 на машине Windows 7. Я получаю эти незначительные ошибки, которые мне действительно не нужны (когда я активирую расширение, мне иногда нужно выйти из WAMP и снова запустить его, чтобы увидеть […]
Есть ли способ документировать, что у определенного класса есть магические методы для каждого метода, определенного в другом классе? Я использую PhpStorm, поэтому я был бы доволен любым решением, которое автоматически запустит автозаполнение. class A { // a bunch of functions go here… } /** * Class B * What should go here to make it […]