代码之家  ›  专栏  ›  技术社区  ›  enanone

从React项目中提取架构

  •  1
  • enanone  · 技术社区  · 6 年前

    记录体系结构是非常好和有用的,除了它需要花费大量的时间去做并且很快就过时了。

    我知道有很多神奇的工具可以从给定的项目中提取体系结构(例如类之间的依赖关系等等)。例如,我使用 Doxygen 在我以前的C++项目中。确实,doxygen是一个通用的文档工具,但它也提供了一些不错的类层次结构,这比 概述 建筑设计。这种方法的明显优势在于它非常适合于持续集成。

    现在,我正在一个使用react框架的typescript(~javascript)项目中工作(如果这很重要的话,还包括redux)。我想知道是否有一个类似于typescript/react项目的工具,它允许我自动提取项目的类层次结构,这样可以提供一些最少的体系结构文档。

    谢谢你的建议!

    附:我不完全确定stackoverflow中是否允许这个问题。如果是这样的话,如果有人告诉我应该把它贴在哪里,我会非常感激的:)

    1 回复  |  直到 6 年前
        1
  •  1
  •   Alien F.    6 年前

    我推荐两种我觉得非常有用的工具:
    打字机
    -gt; https://typedoc.org/
    APIDOC
    -(网站) http://apidocjs.com
    ->(非常酷和容易引导) https://speakerdeck.com/rottmann/api-documentation?slide=12

    typeDoc将帮助您自动提取项目的类层次结构,另一个将帮助您自动生成API文档。

    希望你能在这里找到你需要的。