web-dev-qa-db-ja.com

TypeScriptコードのドキュメント

私の質問はかなり短いです:

TypeScriptコードを適切に文書化するにはどうすればよいですか?プロジェクトがどんどん大きくなっているため、関数を見て、すぐにパラメーター、それが返すもの、副作用などを知ることが重要であることがわかりました。これらの「ブロック」は、スタイルが異なる場合もあります。私が探しているのは、TypeScript用のjavadocやdoxygenなどのドキュメントツールです。何かありますか?または、ドキュメンテーションツールを「乱用」し、それをtypescriptで動作させることは可能ですか?

6
Max Beikirch

JavaDocのようなものを探しているなら、JsDocが役立つかもしれません。

TypeScript定義ファイルのJsDocコメントを、タイプ間のリンクを持つJavaDocスタイルのHTMLページに変換するための小さなツールを作成しました。

あなたはそれをここで見つけることができますが、今はソースから構築する必要があります:

TypeScript-docs

1
Phil Freeman