Недавно я создал CMS для клиента, который предназначен для работы из коробки. Но я допустил ошибку, не комментируя свой код на момент написания. Просто хотел узнать, есть ли инструмент, который будет проходить через файлы CMS и автоматически добавлять блоки комментариев. Предположим, у меня есть этот код: class foo{ function bar(array $array){ print_r ($array); } } […]
Я работаю с Magento. См. Следующий код: <?php echo $this->getChildHtml('topMenu') ?> Есть ли простой способ найти, где находится HTML. Т.е. есть какой-то след, который я могу использовать?
Sphinx – это библиотека Python для создания хорошей документации из набора текстовых файлов в формате RTST. Не инструмент, используемый для полнотекстового поиска Я также полностью знаю инструменты doxygen / phpdoc. Я пытаюсь выяснить, есть ли способ использовать Sphinx для документирования проектов php? или даже любые другие языки, отличные от python? http://sphinx.pocoo.org/
Я играю с PHPDoc и понял, что вы можете использовать уценку, чтобы добавить некоторое форматирование в DocBlock. В частности, я замечаю, что вы можете использовать обратные тики, чтобы выделить встроенный код. Тем не менее, я не могу понять, как добавить блоки кода в DocBlock, поскольку использование 4 пробелов не работает. Я также пробовал использовать <code> […]
Я знаю, что существует много разных стандартов для встроенной документации PHP-кода. Вот что я подразумеваю под встроенной документацией, и, пожалуйста, исправьте меня, если есть лучший термин: /** * This is the description for the class below. * * @package my-package * @subpackage my-subpackage * @author my-name * @version my-version * … */ class orderActions { […]
Для ActionScript 2 я использовал NaturalDocs . Однако он очень плохо поддерживает PHP. Я так долго смотрел на Doxygen и phpDocumentor , но их вывод довольно уродлив, на мой взгляд. Есть ли у кого-нибудь опыт создания автоматической документации для PHP? Я бы предпочел использовать ярлыки в стиле javadoc, они короткие, чтобы писать и легко запоминать.
Я хотел бы создать несколько небольших, но высоко настраиваемых сайтов документации для нескольких проектов. PhpDocumentor довольно велик, но он очень тяжелый. Я подумал о том, чтобы попытаться настроить шаблоны для этого, но, потратив всего пару минут на это, я решил, что это будет слишком много работы. В идеале я хотел бы увидеть что-то, в которое […]
который является правильным способом документировать константы класса для phpDoc? Я прочитал руководство, но я ничего не могу найти о них