Извлечь архитектуру из проекта React - PullRequest
0 голосов
/ 18 января 2019

Архитектура документирования очень приятная и полезная, за исключением того, что она занимает много времени и быстро устареет.

Я знаю, что есть удивительные инструменты, которые извлекают архитектуру (то есть зависимости между классами и т. Д.) Из данного проекта. Например, я использовал Doxygen в своих проектах на C ++. Это правда, что Doxygen является инструментом документирования общего назначения, но также предоставляет некоторую удобную иерархию классов, которая может быть полезна в качестве обзора архитектуры. Очевидным преимуществом этого подхода является то, что он хорошо подходит для непрерывной интеграции.

Прямо сейчас я работаю в проекте Typescript (~ Javascript), который использует инфраструктуру React (также Redux, если это имеет значение). Мне было интересно, есть ли подобный инструмент для проектов Typescript / React, который позволяет мне автоматически извлекать иерархию классов проекта и таким образом предоставлять некоторую минимальную документацию по архитектуре.

Спасибо за любой совет!

PS: я не совсем уверен, разрешен ли этот вопрос в StackOverflow. Если это так, я был бы очень признателен, если бы кто-то сказал мне, где я должен публиковать его:)

1 Ответ

0 голосов
/ 18 января 2019

Я рекомендую 2 инструмента, которые я нашел очень полезными для меня:
Typedoc
-> https://typedoc.org/
apiDoc
-> (веб-сайт) http://apidocjs.com
-> (очень крутая и простая инструкция) https://speakerdeck.com/rottmann/api-documentation?slide=12

Typedoc поможет вам в автоматическом извлечении с иерархией классов ваших проектов, другой поможет вам с автоматической генерацией документации API.

надеюсь, вы найдете здесь то, что вам нужно.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...