Автоматическая документация кода ColdFusion

Я унаследовал более 600 файлов исходного кода ColdFusion, на котором работает мой веб-сайт. Одна из моих задач - "документировать" его. База кода составляет около 5 лет разработки, и нет технической спецификации того, что она делает.

Разработчики сохранили журнал изменений каждого файла, и есть согласованный заголовок.

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

Один вывод, который я изучаю, - это возможность создания xmind файла в качестве средства визуализации перекрестных зависимостей в взаимосвязях модулей.

Спасибо заранее,

Крис

Ответ 1

Сервер ColdFusion имеет встроенный интроспекция, который выводит javadoc как документацию для любого класса CFC.

Смотрите: http://YourColdfusionServer/CFIDE/componentutils/componentdoc.cfm

Однако для этого требуется наличие логина/пароля RDS для вашего сервера. Для доставки третьим сторонам я настроил рекурсивный script, который выполняет выборку cfhttp для docs для каждого файла cfc, а затем компилирует страницы в PDF с помощью cfdocument.

Ответ 2

Вы можете начать с ColdDoc

Кроме того, существует генератор UML 2 CFC.

Я предполагаю, что вам действительно нужно переделать код coldfusion в диаграммы классов uml. Я ничего не знаю с головы.

MagicDraw, Objecteering don ' t, похоже, делает это еще.

Ответ 3

После того, как я попытался найти ответ на этот вопрос, я решил написать это решение:

ColdDuck

Возможно, для вас уже слишком поздно, но я просто распространяю это слово.

Мюррей

Ответ 4

Мне кажется, что создать собственный Xmind или XMI файл - это путь. Файл XMI может быть более переносимым между инструментами, но в последний раз я смотрел на то, что форматы файлов XMI были немного сложными в то время, когда я мог работать над решением. Если форматирование согласованных заголовков достаточно для чтения с помощью ReFind или Find, я бы построил script, который использует cfdirectory и cffile, чтобы пройти дерево кода и вывести файл (ы).