Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ovcharenko-di opened this issue May 26, 2021 · 1 comment

Comments

@ovcharenko-di
Copy link

ovcharenko-di commented May 26, 2021

Есть проект (в статусе заготовки), позволяющий использовать иконки объектов платформы 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    |
@marmyshev
Copy link
Owner

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants