Генератор/редактор веб-документации

Я ищу хороший генератор документации, который поддерживает различные языки программирования, но PHP является обязательным. Дело в том, что я ищу его, чтобы сделать очень конкретную вещь, которая, по сути, создает стандартную автоматическую документацию, такую как определения функций, структуры классов и т. Д., Но затем позволяет мне редактировать их, как я считаю нужным, довольно легко. Добавьте примеры ... добавьте описание и т. Д.Генератор/редактор веб-документации

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

Любые идеи?

источник

2009-09-15 Anonymous

Для получения дополнительных разъяснений, я думаю, вы могли бы сказать, что я ищу что-то вроде PHPDoc, Doxygen и т. Д., Которое генерирует HTML, но затем позволяет легко редактировать его в системе ... как комбинация документации Wiki, но не так широко, как обычная вики. – 2009-09-15 17:54:01

Doxygen делает PHP и другие материалы.

источник

2009-09-15 17:44:07 John

Что выводит HTML, но тогда я должен войти и изменить его вручную. Я ищу что-то с большим интерфейсом управления на задней панели с предопределенными областями для добавления типов данных, описаний, примеров и т. Д., Связанных с документацией по программированию. – 2009-09-15 17:49:34

Вы можете добавить примеры прямо в свой код. Или существуют способы «злоупотреблять» Doxygen для автономных документов. Одна вещь, о которой я бы хотел убедиться, заключается в том, что вы не поддерживаете знания более чем в одном месте ... если все, что связано с вашей документацией, генерируется из четко определенного набора файлов и из комментариев в источнике, то вы стоите больше шансов сохранить все согласованно. – John

John, я действительно хотел бы избавиться от существующих комментариев в коде, за исключением процедурных комментариев. Хотя я понимаю, что многие крупные проекты используют Doxygen и делают exentensive templating, а что нет, я бы хотел, чтобы эта документация была более динамичной с точки зрения пользователя. То есть, если изменения API или новые методы будут изменены, я бы не хотел просто повторно запускать его и получать статические страницы, но повторно запустить его и иметь старые методы/классы «скрытые» и, возможно, изменить его в API , и т. д., комментарии, сделанные до изменения, по сравнению с комментариями/примерами, сделанными после и т. д. – 2009-09-15 18:31:59

Посмотрите на this для конкретного инструмента PHP. Doxygen также имеет некоторые PHP поддержку

источник

2009-09-15 17:46:10 Jared

Я знаю об этом инструменте или, по крайней мере, PHPDoc, но он страдает от той же проблемы, о которой я упоминал в комментарии выше, где я не может легко изменить его, не работая с HTML для запуска WYSIWYG. – 2009-09-15 17:52:21

Я искал что-то подобное себе навсегда, кажется, как .. единственное решение я приблизиться к поиску, но нету»пытался это phpdoc-> docBook-> Обсуждение MediaWiki

источник

2010-02-06 00:31:05 David

Генератор/редактор веб-документации

ответ

Смежные вопросы