Jsdoc コメント
JetBrains Rider は Jsdoc コメント(英語)を認識し、開始ブロックコメント /**
を入力して Enter を押すと、@param
、@returns
、@private
やその他のタグを自動的に挿入することで作成できます。JSDoc コメントは、JavaScript および TypeScript での Ctrl+Q を使用したドキュメント検索に使用されます。JavaScript ドキュメントの検索および TypeScript ドキュメントのルックアップを参照してください。また、連鎖メソッドでの型アノテーションおよびメソッド戻り型ヒントにも使用されます。
JetBrains Rider は、ドキュメントコメント内の TODO パターン、Closure コンパイラー(英語)アノテーション、TypeScript 構文も認識し、コード補完、インテンションアクション、その他のタイプのコーディング支援で使用します。
JSDoc 入門(英語)および JSDoc でサポートされているタイプ(英語)の例を使用して、JSDoc 構文の詳細な説明を見つけてください。
JSDoc コメントを作成する
文書化するメソッド / 関数またはフィールドの宣言の前にキャレットを置き、開始ブロックコメント
/**
を入力して、Enter を押します。JetBrains Rider は、該当する場合、パラメーター(
@param
)と戻り値(@returns
)のリストを含む JSDoc コメントを生成します。リストされたパラメーター、戻り値などを記述します。あるいは、専用の doc コメントの修正アクションを使用します。文書化するメソッド / 関数またはフィールドにキャレットを置き、Ctrl+Shift+A を押して
Fix Doc Comment
の入力を開始します。次に、リストから doc コメントの修正を選択し、Enter を押します。
JSDoc コメントの TypeScript 構文
JavaScript ファイルの JSDoc コメント内で、TypeScript アノテーション(@type
や @typedef
など)を使用できます。JetBrains Rider は、@typedef
宣言の共用体型(英語)やオプションのプロパティなど、TypeScript 構文構造を認識します。
JetBrains Rider は、TypeScript アノテーション用のコード補完を提供します。
@type
アノテーションに基づいて、JetBrains Rider はパラメーターのヒントを表示します。
エディターでレンダリングされた JSDoc コメントを表示する
JetBrains Rider を使用すると、JSDoc コメントを読みやすい形式で表示できます。このレンダリングされたビューモードでは、アイテムは @
タグでグループ化されて表示されますが、タグ自体はスキップされます。参照先の Web ページを開いて、参照先のトピックのクイックドキュメントを表示し、読みやすくするためにフォントサイズを調整できます。
レンダリングされたビューモードに入るには、コメントの上にマウスを置き、余白の をクリックするか、Ctrl+Alt+Q を押します。アイコンが に変わります。
レンダリングされたビューモードを終了するには、ガターで をクリックするか、JSDoc コメントのコンテキストメニューからレンダリングビューの切り替えを選択するか、Ctrl+Alt+Q を押します。
現在のファイルのすべての JSDoc コメントに対してレンダリングされたビューモードをオンにするには、ガターのコンテキストメニューからすべての Doc コメントをレンダリングを選択します。
必要に応じて、コンテキストメニューからフォントサイズの調整を選択し、スライダーを使用してフォントサイズを変更します。
デフォルトでレンダリングされるすべての JSDoc コメントを表示するには、設定 / 環境設定ダイアログ(Ctrl+Alt+S)を開き、 に移動して、ドキュメントコメントをレンダリングするチェックボックスを選択します。
レンダリングビューのガターアイコンを非表示にするには、ガターのコンテキストメニューからガターアイコンの構成を選択し、開いた ページのドキュメントコメントの直接描画チェックボックスをオフにします。
関連ページ:
JavaScript ドキュメントの検索
JetBrains Rider は、標準の JavaScript API、プロジェクトとその依存関係からのシンボル、外部ライブラリで定義されたシンボルのリファレンスを示しています。ドキュメントポップアップでシンボルのドキュメントを表示し、リンクが利用可能な場合は外部サイトのドキュメントを開くことができます。プロジェクトシンボルまたはプロジェクト依存のシンボルの場合、JetBrains Rider は対応する JSDoc コメントからドキュメントを生成します。標準の JavaScript オブジェク...
言語およびフレームワーク: TypeScript
JetBrains Rider は、TypeScript ソースコードの開発、実行、デバッグをサポートしています。JetBrains Rider は .ts および .tsx ファイルを認識し、追加の手順なしで編集するための幅広いコーディング支援を提供します。TypeScript ファイルはアイコンでマークされています。TypeScript 対応のコーディング支援には、キーワード、ラベル、変数、パラメーター、関数の補完、エラーと構文のハイライト、フォーマット、多数のコードインスペクションとクイックフィック...
言語およびフレームワーク: JavaScript
JetBrains Rider を使用すると、JavaScript および Node.js を使用して最新の Web、モバイル、デスクトップアプリケーションを開発できます。JetBrains Rider は、React、Angular、Vue.js、その他のフレームワークもサポートし、Web 開発用のさまざまなツールとの緊密な統合を提供します。JavaScript 対応のコーディング支援には、キーワード、ラベル、変数、パラメーター、関数の補完、エラーと構文のハイライト、フォーマット、コードインスペクシ...
JavaScript ライブラリを構成する
言語と IDE のコンテキストでは、ライブラリはファイルまたはファイルのセットです。これらのファイルの関数とメソッドは、編集したプロジェクトコードから JetBrains Rider が取得する関数とメソッドに加えて、JetBrains Rider の内部知識に追加されます。プロジェクトのスコープでは、そのライブラリはデフォルトで書き込み保護されています。JetBrains Rider は、2 つの事前定義された自動生成ライブラリフォルダーを予約します。node_modules プロジェクト pac...
Chrome での JavaScript のデバッグ
JetBrains Rider は、client-sideJavaScript コード用の組み込みデバッガーを提供します。以下のビデオと手順では、このデバッガーの使用を開始するための基本的な手順を説明しています。始める前に:設定で JavaScript と TypeScript バンドルプラグインが有効になっていることを確認します。を押して設定を開き、を選択します。インストール済みタブをクリックします。検索フィールドに JavaScript と TypeScript と入力します。プラグインの詳細に...