打字稿项目文档和UML图表

时间:2017-06-30 09:03:00

标签: class typescript uml

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

我想知道如何记录我的项目以及如何为我的打字稿项目绘制类图。

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

提前致谢!!!

1 个答案:

答案 0 :(得分:-1)

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

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