Typescript 项目文档和 UML 图

Typescript Project Documenting and UML diagrams

我有一个相当不错的 Typescript 项目。有几个 类 接口,它已经扩展了相当多的数量。

我想知道如何记录我的项目以及如何绘制 Class 我拥有的 typescript 项目的图表。

我还能做些什么让初级开发人员理解它?还有什么图表对项目有好处。

提前致谢!!!

我建议使用 JSDoc 约定注释您的 TypeScript 代码,编译您的 TS 代码而不删除注释(removeCommentsfalse in tsconfig.json),并在 JS 文件上使用文档生成器。

基于此,您也许可以找到一个工具来从 JSDoc 生成 UML 图:JSDoc UML Diagram