Было-бы не плохо для каждой сущности в свойствах сделать поле для ее кратенького описания. А потом в студии при выборе ее в списке где-то тут-же (в статусной строке?) этот комментарий отображать. Когда их очень много - проще было-бы ориентироваться.
Задумался.
Смотрю на свои проекты, смотрю на Cuba Studio, смотрю на Context Help и понимаю, что определённо какая-то идея витает в воздухе.
Попробую тут расписать эти ощущения.
Существует т.н. JavaDOC - документация для приложений. Без неё в ряде проектов сложно,а уж в коммерческих - тем более.
Если настройку развёртывания ещё можно/нужно прописать в файлах корня проекта, то документацию - уже не очень.
М.б., добавить JAVADOC-редактор для тех сущностей, которые неплохо получается изменять в студии непосредственно?
Тут же напрашивается написание модульных тестов сущностей тут же, где та или иная сущность объявлена ( как вариант, там же. где и SOURCE, DDL и прочие меню.
т.о., идея сводится к добавлению двух новых вкладок:
Module Test , Java Doc.
И чтобы справа можно было бы посмотреть вместо контекстного меню - описание той сущности, что изменяется/просматривается.
Эти описания можно выводить в модель данных и это как раз Java Doc. Можно еще подумать и о локализации этой информации.
Присоединяюсь.
Недавно начал изучение CUBA, но практически сразу при создании модели возник вопрос, есть ли какой-то способ вести документацию. Так аналитикам будет проще читать проект. Также неплохо бы добавить эту документацию к выводу Help -> DataModel (domain-description.html).
Ведение в рамках javadoc убивает двух зайцев, позволяя читать документацию и аналитикам, и разработчикам. А вот с локализацией по-моему уже перебор 
Привет. коммьюнити!
Мы опубликовали JavaDocs/ API reference, ссылки на скомпилированные доки размещены на странице документации.
Приветствуем и ждем PR на гитхабе!
Спасибо за идею, я создал соответствующий тикет: https://youtrack.cuba-platform.com/issue/STUDIO-4635
Попробуем запланировать его реализацию
1 симпатия