Вопрос

Использует ли кто-нибудь что-нибудь еще для документирования своих PHP код, чем PHPDoc?Существуют ли какие-либо инструменты, которые читают тот же синтаксис документации, но дают более богатый результат?

Это было полезно?

Решение

Я тоже выберу доксиген.

Вот несколько причин:

  • совместим с тегами phpdoc и другими популярными:это совместимо
  • работает с различными языками программирования:лучшее вложение времени
  • существует альтернативный синтаксис:можете выбрать стиль комментирования, который вам подходит
  • очень эффективен благодаря расширенному форматированию/тегированию/метаданным
  • существует графический интерфейс, который не связан ни с какой IDE, а также плагин eclipse.

И при этом бесплатный, мультиплатформенный и с открытым исходным кодом :-)

Его легко освоить, но сложнее, чем phpdoc, потому что он намного богаче.

Другие советы

Вы можете попробовать DocBlox;который задуман как альтернатива phpDocumentor, но с поддержкой дополнительных функций, одной из которых является полная поддержка PHP 5.3.Дополнительным преимуществом является то, что он довольно быстрый и использует относительно мало памяти.

Вы можете прочитать больше на http://www.docblox-project.org или посмотрите демо на http://demo.docblox-project.org/default

Другой вариант, кроме phpDocumentor: Доксиген документация с PHP поддерживать.

Доксиген (www.doxygen.org).

АпиГен

http://apigen.org/

ApiGen поддерживает пространства имен, пакеты PHP 5.3, связь между документацией, перекрестные ссылки на стандартные классы PHP и общую документацию, создание выделенного исходного кода и экспериментальную поддержку особенностей PHP 5.4.

ДокБлокс

http://www.docblox-project.org/

Генератор документации API, совместимый с PHP 5.3, предназначенный для проектов любого размера и непрерывной интеграции.

способен полностью анализировать и трансформировать Zend Framework 2

Я использую Доксиген тоже - к различным ключевым словам очень быстро привыкаешь - они как бы говорят сами за себя.;)

РубиДок тоже хорошо, мне особенно нравится расположение rdocs.

Doctrine использует PHPDoctor, который, по моим тестам, хорошо работает с версией 5.3.

http://peej.github.com/phpdoctor/#download

Я не использовал его с PHP, но доксиген утверждает, что поддерживает язык.

Если вам нужно документировать код для PHP 5.3+, например.если он использует пространства имен Теда Калпа форк PHPDoctor может быть ваш ответ.

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top