Автоматическое создание документации PHP?

Есть два хорошо известных php-errors и часто используемых инструмента, которые php могут генерировать документацию php API из блоков документов:

• phpDocumentor, специфичный для PHP и, вероятно, один из наиболее часто используемых инструментов для проектов PHP.
• и Doxygen, что больше для C, но используется некоторыми людьми для PHP.

По documentation-generator поводу «руководящих принципов»: я documentation бы сказал, что это зависит php-fpm от ваших проектов, но, по php5 крайней мере, я ожидал увидеть:

• описание того, что делает метод / функция
• параметры с @param type name description of the parameter
• возвращаемое значение с @return type description of the return value
• исключения, с @throws type description of the exception that can be thrown

Замечательно php-cli то, что недавняя среда IDE documentation-generator (например, Eclipse PDT) может читать и интерпретировать php5 эти маркеры, чтобы давать php-mail подсказки при кодировании documentation-generator ;-)

Кроме того, появляется php-include все больше и больше инструментов php-cli PHP, которые используют php php5 docblocks для других целей, кроме php-fpm документации.

Например, PHPUnit php-fpm позволяет вам указывать некоторые docs вещи, связанные с тестами, используя php-fpm определенные теги - см. Annotations.