Диаграмма JSDoc UML

Вопрос: я редактирую и использую библиотеку javascript с открытым исходным кодом, в коде которой есть теги JSDoc. Мне было интересно, знает ли кто-нибудь о плагине JSDoc, который позволил бы мне генерировать диаграмму классов из тегов JSDoc.

Изменить Я решил попробовать js/uml и нашел следующее. Расширение JS/UML eclipse требует более старой версии Eclipse (Indigo) и неподдерживаемой библиотеки зависимостей UML2tools. Я нашел необходимые зависимости и в соответствии с программным менеджером Eclipse установлен правильно. Когда я пытался включить функциональность uml (настроив корень js), процесс зависал. Примеры, которые предоставляет группа, указывают на один файл Javascript. Кажется, есть проблемы с несколькими файлами, на которые есть ссылки.

2 ответа

Вы можете использовать инструменты Doxygen, он предоставляет метаданные для создания диаграммы классов UML

http://plantuml.sourceforge.net/doxygen.html

Не уверен, на что были способны предыдущие версии JSDoc, но JSDoc теперь поддерживает классы Javascript и ключевое слово extends. Если код размечен правильно, JSDoc может понимать наследование классов.

Может создать плагин JSDoc, который подписывается на событие processingComplete: "Событие processingComplete наступает после того, как JSDoc обновляет результаты анализа, чтобы отразить унаследованные и заимствованные символы". http://usejsdoc.org/about-plugins.html

Затем вы можете перебирать Doclets (объекты, представляющие элементы кода) и сериализовать свой собственный JSON. Затем вы можете написать простой HTML-рендерер для JSON-описания вашего исходного кода.

Другие вопросы по тегам