Автоматическая генерация документов INLINE - PullRequest
0 голосов
/ 09 февраля 2011

Прежде всего, я не спрашиваю о том, как генерировать документацию из исходного кода PHP.Это достаточно просто с такими библиотеками, как Doxygen или PHPDocumentor.То, что я ищу, - это способ автоматически генерировать встроенные заглушки комментариев на основе phpdoc для классов, методов, свойств и т. Д. Существуют ли какие-либо уже существующие библиотеки, которые могут это сделать?Я немного искал и ничего не придумал.

Я спрашиваю только потому, что у меня зуд, я хочу поцарапать, написав свой собственный.Я склонен тратить ЧАСЫ на то, чтобы набрать код и сохранить документацию в качестве последнего шага (я знаю, я действительно должен делать это КАК я иду).Проблема заключается в том, что, даже осознавая важность встроенной документации, после 8 часов подряд написания кода и написания дюжины классов с десятками методов и свойств, немного отговаривать от необходимости останавливаться и начинать писать материал.

Очевидно, я не могу автоматически создавать ПОЛНУЮ документацию.Такие вещи, как подробные описания классов, свойств и методов, должны быть набраны вручную.Но, используя рефлексию, я могу легко получить достаточно информации для создания заглушек комментариев с заполнителями-заполнителями.

Если кто-нибудь может помочь мне в поиске такого решения, как AWESOME.Если нет, я займусь созданием нового репозитория Github и внесу что-то полезное для сообщества.:)

Ответы [ 2 ]

1 голос
/ 18 февраля 2011

DocumentX может (повторить, может) сделать это.

1 голос
/ 16 февраля 2011

Нужна помощь с docgen? Программное обеспечение для генерации документов загружено материалами, которые помогут максимально использовать docgen. Очень хорошие предложения о том, как оптимизировать систему Docgen

...