Typescriptプロジェクトのドキュメント化とUMLダイアグラム

Question

私はかなりまともなTypescriptプロジェクトを持っています。いくつかのクラス、インターフェースがあり、かなりの量のスケーリングが行われています。

自分のプロジェクトをどのように文書化できるのか、私が持っているtypescriptプロジェクトのクラス図をどのように描くことができるのか知りたかったのです。

ジュニア開発者が理解できるように他に何ができますか？他にどのような図がプロジェクトにとって良いでしょうか。

ありがとうございます!!!

Answer 1

私は（ tsconfig.json にremoveCommentsfalseに）コメントを剥ぎ取ることなく、あなたのTSコードをコンパイルし、JSDocの規則を使用して、あなたの活字体のコードのコメントを示唆している、とJSファイル上のドキュメントジェネレータを使用しています。

これに基づいて、JSDocからUML図を生成するツールを見つけることができます。JSDoc UML Diagram