concurrent-world icon indicating copy to clipboard operation
concurrent-world copied to clipboard

TypeDocを導入する?

Open totegamma opened this issue 2 years ago • 0 comments

ドキュメントがあったほうが良いよねみたいな話はあるんだけど、ぶっちゃけディレクトリ構造とコード読めば分かるしいいかな...みたいなところもあり...

自動生成ドキュメントって、そのライブラリを使う側としては参照するんだけど、作る側としては見ることないよね...。

ただ、コメントが少なすぎるのは事実で、TypeDocを導入するのはある種コメントを書く機械的な強制力になって良いかな~みたいな気持ちはあります。

ほんとにTypeDocでいいのかは検討中だけど、それはそれとしてTsDoc形式で書いておけばなんでも良いでしょみたいなところはある。

totegamma avatar Aug 24 '23 16:08 totegamma