2011-02-09 3 views
0

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

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

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

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

+1

В ряде IDE (таких как Eclipse) есть функция, которая может генерировать для вас заглушки PHPDoc –

+0

+1 Да, я действительно ищу способ сделать это программно. В основном, запустите его из командной строки и укажите каталог (+ фильтры) для повторения и документа. Я действительно знаю, что Eclipse делает это, но, к сожалению, я использую Netbeans, и я не могу найти эту функциональность. В любом случае, это был бы забавный маленький любимый проект. :) –

+1

Возможный дубликат [Инструмент для добавления и завершения документации исходного кода PHP] (http://stackoverflow.com/questions/1936376/a-tool-to-add-and-complete-php-source-code-documentation) –

ответ

1

ДокументX может (повторить) мог бы это сделать.

1

Нужна помощь с docgen? Document generation software загружен материалом, который поможет максимально использовать docgen. Очень хорошие предложения о том, как оптимизировать систему docgen