ColdFusion и документирование кода, а также инструменты для нескольких команд разработчиков.

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

Еще одна проблема, которую я надеюсь избежать (либо с адекватной документацией по коду, либо с помощью какого-либо другого инструмента), — это дублирование кода. Инструмент, который мог бы «индексировать» код для поиска или построения диаграмм, вероятно, поможет здесь.

Что другие там используют либо специально для ColdFusion, либо независимо от языка. Мы, вероятно, будем использовать ColdBox для базовой структуры, если это будет иметь значение.

Спасибо за любые предложения.

-c


code-documentation coldfusion coldbox diagramming
person cra    schedule 22.08.2012    source источник

Ответы (3)


arrow_upward
2
arrow_downward

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

Инструменты, не зависящие от языка:

Специальные инструменты для ColdFusion:

Инструменты, специфичные для Javascript:

В идеале ваш сервер сборки Jenkins должен:

  • Выполните новую проверку из системы управления версиями
  • Запустите все модульные тесты и остановите сборку, если они не пройдут
  • Создание документации
  • Создайте готовый к производству пакет вашего проекта

Как минимум, я настоятельно рекомендую использовать систему управления версиями, настроить Jenkins с тестами MXunit и планировать ежедневные автоматические сборки.

person Russ    schedule 24.08.2012
comment
Я второй с помощью Дженкинса. Мы используем его в нескольких средах, и это значительно сокращает время сборки. Кроме того, мы используем его для управления нашими стандартами кодирования. Например, любой экземпляр HTMLEditFormat помечается и отправляются уведомления (должно быть EncodeFor{context}). Кроме того, у ColdBox теперь есть TestBox, доступный в качестве замены MXUnit. - person Adrian J. Moreno; 08.02.2014
comment
Похоже, что ссылка на ColdDoc больше недоступна, и проект, похоже, не обновлялся с 2012 года. Известны ли вам какие-либо другие инструменты для создания документации, предназначенные для Coldfusion? - person Antonio; 01.10.2015
comment
Похоже, здесь есть относительно актуальная вилка ColdDoc: github.com/Ortus-Solutions/DocBox - person Russ; 02.10.2015

arrow_upward
0
arrow_downward

Мы использовали пакет Atlassian на моей последней работе. В основном Jira для отслеживания и Greenhopper для agile, но могут помочь и другие инструменты: fisheye, bamboo и тигель. Если вы размещаете его самостоятельно, я полагаю, что у них есть одноразовая цена в 10 долларов за продукт. В зависимости от размера вашей команды может или не может работать. Если деньги не имеют значения, набор работал очень хорошо. Он также имеет встроенную поддержку svn и, возможно, больше.

http://www.atlassian.com/software

person Travis    schedule 22.08.2012
comment
Спасибо за рекомендацию. Я посмотрю. - person cra; 23.08.2012

arrow_upward
0
arrow_downward

Мне кажется, что вам нужна методология, а не инструмент. Если у вас есть четко определенный набор объектов/обязанностей. В сценариях не должно быть пересечений, и если вы определите общий API для кодируемых объектов, я думаю, у вас все будет хорошо.

person Nicklepedde    schedule 22.08.2012
comment
Согласованный. Одна из причин, по которой я настаиваю на использовании базового фреймворка (склоняюсь к ColdBox). Тем не менее, использование какого-либо инструмента документирования кода, вероятно, было бы очень полезным. - person cra; 23.08.2012
comment
Я думаю, что лучшее, что вы найдете, - это ответственный программист, я сомневаюсь, что какой-либо реальный инструмент сделает это за вас. И да, я видел структуру ColdBox, но я имел в виду, что вы устанавливаете согласованный стандарт того, как создаются объекты в вашем коде. - person Nicklepedde; 23.08.2012