質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

89.63%

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

解決済

回答 1

投稿

  • 評価
  • クリップ 1
  • VIEW 97

yuki_90453

score 144

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

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


宜しくお願いします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+3

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2020/02/14 17:57

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

    キャンセル

  • 2020/02/15 00:36

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

    キャンセル

  • 2020/02/15 00:53

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

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

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 89.63%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる