2016-12-01 14 views
7

私は、Visual Studio CodeでAngular 2/Typescriptプロジェクトを構築してきており、丁寧にJSDocコメントブロックを追加していますが、今はJSDoc出力を見たいと思います。私は自分のJSDoc生成システムをインストールしてセットアップすることができましたが、VSCのすてきなGUIサポートがあれば、VSCからJSDoc権限を生成して表示することは合理的です。Visual StudioコードでJSCodeで生成されたドキュメントを表示するにはどうすればよいですか?

私のGoogle-Fuは私に失敗しました。私が「Visual Studioコード内でJSDoc出力を生成する」を探すたびに、JSDocコメントブロックを生成するためのプラグインを取得するだけです。

Visual Studioコード内にJSDoc出力を生成して表示する方法はありますか?

+0

https://www.npmjs.com/package/tsdocをチェックアウトしましたか? – Digvijay

+0

... http://typedoc.org/api/ - 端末から何ができるかを言うための拡張子はありません... – JGFMK

+0

すべてのメソッドを表示するには 'Ctrl + Shift + O'を押してくださいそこでメソッドを選択し、そのメソッドの上にマウスを移動すると、対応するJSDocが開きます。 – Manubhargav

答えて

1

そこサポートが組み込まれていないが、しかし、あなたは簡単に適切なJSDocのコマンドを実行しますタスクを追加することができますように私は、それが必要だとは思わない。私の知る限りこれは、あなたが「あなた自身のJSDocの生成システムをセットアップする」の意味するものであるかどうかは知りませんが、それはすぐに行われています:

  1. まず、端末からJSDocのジェネレータをインストールします。npm install -g jsdoc(あなたはNode.jsのを持っていると仮定/ npm)。
  2. (例えばメニューから:[タスク] - > [設定タスク) - タスクを設定
  3. http://usejsdoc.org/about-commandline.htmlを参照してください)あなたはJSDocのために必要がある引数を決め詳細はhttps://code.visualstudio.com/Docs/editor/tasksを参照してください(あなたも、キーボードショートカットを追加することができます)
  4. 生成されたHTMLページをJSDocsで開きます。
+0

ありがとう:最高の答え。 –

1

vscodeで役立つjsdocsはintellisenseです。

は、私が試してみて、関数を呼び出すたびその後vscodeが私にこの記述jsdocsが表示されます、私はこの機能

/** 
* This squares a function 
* @param x takes this value and doubles it 
*/ 
function myAwesomeFunction(x: number) { 
    return x *x; 
} 

を持っていると言います。

enter image description here

+0

良い情報ですが、私はそれを知っていましたが、それは本当に別の質問(私はおそらくいつか質問します)への答えです。ありがとう! –

関連する問題