文档架构非常好而且很有帮助,除了它需要花费大量时间并且很快过时。
我知道有很多很棒的工具可以从给定的项目中提取架构(即类之间的依赖关系等)。例如,我以前在我的C ++项目中使用过Doxygen。确实,Doxygen是一个通用的文档工具,但是它提供了一些不错的类层次结构,而不是可用作体系结构的 overview 。这种方法的明显优势在于它非常适合连续集成。
现在,我正在使用React框架的Typescript(〜Javascript)项目中工作(如果需要的话,还可以使用Redux)。我想知道是否有用于Typescript / React项目的类似工具,该工具可让我自动提取项目的类层次结构,并以此方式提供一些最少的体系结构文档。
谢谢您的任何建议!
PS:我不太确定StackOverflow是否允许使用此问题。如果是这样,如果有人告诉我应该在哪里发布它,我将不胜感激:)
答案 0 :(得分:1)
我推荐2种对我非常有用的工具:
Typedoc
-> https://typedoc.org/
apiDoc
->(网站)http://apidocjs.com
->(非常简单易用的指南)https://speakerdeck.com/rottmann/api-documentation?slide=12
Typedoc将帮助您自动提取项目的类层次结构,另一个将帮助您自动生成api文档。
希望您会在这里找到所需的东西。