TypeScriptとVScodeにおいて、型のプロパティに説明文をつける方法

Question

TypeScriptにおいて、オブジェクの型情報を作る際。
プロパティについての説明文を付け、VS codeでサジェストされる際にその説明文を出力する方法はありますか？
オブジェクトはAPIへpostを想定していますのでプロパティの名前は変更出来ません。

export type stocks = {
    option1_value:string, // カラーの選択肢名
    option2_value:string, // サイズの選択肢名
    stocks:string
}[]

宜しくお願いします。

Answer 1

vscode jsdoc typescript でググると、こちらの記事が見つかりました。

Comments

[yuki_90453]

JSDoc知りませんでした、参考になりました、ありがとうございます。

[thyda.eiqau]

はい、documentation commentって、言語によって呼び方が違うのでちょっと困惑しますよね。まず「javascript documentation comment」でググると「JSDoc」という言葉に辿り着けるのですが、確かに二度手間ではありますね。とはいえ、思いつく単語でググって苦労して答えにたどり着く、というのもプログラマとしてやっていく上で必要なプロセスでもあります。そのうち勘所がわかってきて、ググる際のキーワード選びが短時間でできるようになってきますね。

[yuki_90453]

丁寧にご回答ありがとうございます。
いつも的確なキーワードを選定できず、なかなか解決出来るポイントを探るのに苦労していました。
本心を言いますので、かなり抽象的な質問をして申し訳ない気持ちがございます。
まだまだプログラムをやっていく上での感を未熟な事にもどかしい気持ちがございますが、なんとかレベル感を養えるよう努力していきたいと思います。
この度は回答ありがとうございました。

また機会がございましたら、ぜひアドバイスお願い致します。