edt-plugins icon indicating copy to clipboard operation
edt-plugins copied to clipboard

Отображение диаграмм PlantUML, в которых есть упоминание текущего объекта метаданных

Open ovcharenko-di opened this issue 3 years ago • 1 comments

Есть проект (в статусе заготовки), позволяющий использовать иконки объектов платформы 1С на диаграммах PlantUML. Это позволяет описывать модель системы не на абстрактных сущностях UML, а на вполне конкретных, которые есть в платформе.

Описание моделей системы в виде диаграмм нужно, в первую очередь, для повышения эффективности обмена информацией внутри команды: диаграммой можно быстро и емко описать какую-то концепцию, подход, наглядно отобразить взаимосвязи сущностей. При размещении диаграмм в том же репозитории, что и конфигурация (согласно концепции Documentation as Code) было бы удобно иметь команду в EDT, которая выводит список всех диаграмм, в которых упоминается выбранный объект метаданных. При выборе одной из таких диаграмм EDT должна отобразить ее (см. PlantUML Eclipse Plugin https://github.com/hallvard/plantuml). С помощью этого плагина разработчик сможет быстро находить документацию, связанную с интересующим его объектом метаданных (тем самым, оставаться в контексте решаемой задачи).

Пример:

@startuml
!include dist/common.puml
!include dist/v8_Document.puml

_Документ(ПриобретениеТоваровУслуг, "Приобретение товаров и услуг")
@enduml

В примере первый параметр присвоит alias элементу на диаграмме, он же является именем объекта метаданных. Макрос _Документ говорит о том, что это именно документ, а не какой-то другой тип.

Сценарий: Поиск диаграмм, в которых упоминается текущий объект метаданных
    Дано у меня открыт проект EDT
    И в репозитории проекта есть каталог ./docs/plantuml
    
    Когда в панели с конфигурацией я активизирую строку Документ.ПриобретениеТоваровУслуг
    И я нажимаю комбинацию клавиш Ctrl+?
    Тогда я жду, что в панели Диаграммы PlantUML появится таблица:
    | Диаграмма       | 
    | ЗакупкаТМЦ.puml |
    | Закупки.puml    |

ovcharenko-di avatar May 26 '21 07:05 ovcharenko-di

А можешь еще дописать, про само использование UML в EDT, в чем польза, как это применять для приложений 1С?

нашел ссылку на плагин UML - добавил ссылку в пост.

marmyshev avatar May 26 '21 08:05 marmyshev