TSDoc を書きたい & TSDoc で使えるタグ一覧 - ぽ靴な缶

いつも TypeScript 書いてるんですよ、そしたら function の前にコメント書くじゃないですか、/** ... */ で書いてるけど正直のところ中身は勘で書いている。@returns や @deprecated とかよく見るし、雰囲気で使っているけど、本来なんのタグが使えるかあんまり誰も分かってない。補完のときに表示されてラッキーぐらいの感覚。でも謎のタグを使ってるの見たら気になるし、今 TypeDoc でドキュメント生成していなくても、標準的なフォーマットがあるなら従っておきたいじゃん。そして TSDoc でインターネットを検索しても、こう書けばいいみたいな記事がすぐ見つからねぇ〜〜 まだ標準は無い リポジトリ見に行く microsoft/tsdoc: A doc comment standard for the TypeScript language ふむふむ、現行の多く

[maecchi]

TSDocタグあまり理解していなかったので助かります。

[tofu-kun]

いまいちここら辺の流儀が完全に理解できていなくて雰囲気でやってる

[nabeop]

最近、TS 書いていて TSDoc でウッとなることがあったのでありがたい。