Альтернатива phpDocumentor, потребляющая меньше памяти - PullRequest
8 голосов
/ 29 апреля 2010

Хорошо, я сыт по горло phpDocumentator . Он потребляет гораздо больше памяти (1,4 ГБ) и времени (5 минут на 2,6 ГГц Core 2 Duo), чем я готов дать. Существует ли действительно совместимая программа для создания документации для кода PHP?

Я пробовал PHPDoctor , который выглядит неплохо, но у него есть отсутствующие функции . Однако это, вероятно, ближе всего будет замена из всех решений, которые я пробовал до сих пор.

Я также пытался PhpDocGen , но он просто выдает некоторые ошибки Perl, которые мне лень изучать.

Doxygen, похоже, не очень хорошо работает с нашими источниками.

PS: документация будет для phpMyAdmin , немного устаревшая документация здесь .

Обновление: код содержит множество функций, а не только объектов, что является самой большой проблемой в Doxygen, потому что он не может их организовать.

Ответы [ 4 ]

3 голосов
/ 17 февраля 2011

Вы также можете попробовать DocBlox; это новый ребенок в блоке (каламбур), но он уже поддерживает многие функции, которые предоставляет phpDocumentor, и многие новые функции (например, пространства имен). Пожалуйста, попробуйте на https://www.github.com/mvriel/Docblox

3 голосов
/ 29 апреля 2010

Мы перешли с phpDocumentor на Doxygen , поскольку первый не поддерживал функции PHP 5.3, такие как пространства имен и замыкания. Последнее обновление phpDocumentor было в 2008 году.

Основные атрибуты @ одинаковы в Doxygen, потому что они оба делают комментарии в стиле JavaDoc. Он также вполне настраиваемый.

2 голосов
/ 06 мая 2010

Doxygen довольно сложный, и он должен поддерживать функции PHP 5.3. Однако, это не сработало так, как я хотел, и я понял, что это большая программа, но не предназначена для PHP; поэтому мне нужно было что-то более легкое, более простое и предпочтительно эксклюзивное для PHP, потому что давайте посмотрим правде в глаза, PHP не имеет достаточно общего синтаксиса языка программирования и выглядит.

Я знаю, что вы упомянули об этом, но в конце концов я выбрал PHPDoctor. Ему действительно не хватает некоторых функций, но он простой и быстрый, именно то, что я искал.

Дайте нам знать, что вы выбрали и по каким причинам.

Также стоит упомянуть, что я обнаружил, что интерфейс PHPDoctor довольно прост и легок в оформлении (с небольшими изменениями CSS). Мне удалось создать довольно чистую страницу для моих документов.

1 голос
/ 29 апреля 2010

Я использую Natural Docs , у меня хорошо работает

...