RubyMine 2024.1 ヘルプ

Jsdoc コメント

RubyMine は Jsdoc コメント(英語)を認識し、開始ブロックコメント /** を入力して Enter を押すと、@param@returns@private やその他のタグを自動的に挿入することで作成できます。JSDoc コメントは、JavaScript および TypeScript での Ctrl+Q を使用したドキュメント検索に使用されます。JavaScript ドキュメントの検索および TypeScript ドキュメントのルックアップを参照してください。また、連鎖メソッドでの型アノテーションおよびメソッド戻り型ヒントにも使用されます。

RubyMine は、ドキュメントコメント内の TODO パターンClosure コンパイラー(英語)アノテーション、TypeScript 構文も認識し、コード補完、インテンションアクション、その他のタイプのコーディング支援で使用します。

JSDoc 入門(英語)および JSDoc でサポートされているタイプ(英語)の例を使用して、JSDoc 構文の詳細な説明を見つけてください。

JSDoc コメントを作成する

  • 文書化するメソッド / 関数またはフィールドの宣言の前にキャレットを置き、開始ブロックコメント /** を入力して、Enter を押します。

    RubyMine は、該当する場合、パラメーター(@param)と戻り値(@returns)のリストを含む JSDoc コメントを生成します。リストされたパラメーター、戻り値などを記述します。

    Generate jsdoc comment
  • あるいは、専用の doc コメントの修正アクションを使用します。文書化するメソッド / 関数またはフィールドにキャレットを置き、Ctrl+Shift+A を押して Fix Doc Comment の入力を開始します。次に、リストから doc コメントの修正を選択し、Enter を押します。

JSDoc コメントの TypeScript 構文

JavaScript ファイルの JSDoc コメント内で、TypeScript アノテーション(@type@typedef など)を使用できます。RubyMine は、@typedef 宣言の共用体型(英語)やオプションのプロパティなど、TypeScript 構文構造を認識します。

RubyMine は、TypeScript アノテーション用のコード補完を提供します。

Code completion for TypeScript annotations within JSDoc in a JavaScript file

@type アノテーションに基づいて、RubyMine はパラメーターのヒントを表示します。

Parameter hints are shown based on type annotations within JSDoc in a JavaScript file

エディターでレンダリングされた JSDoc コメントを表示する

RubyMine を使用すると、JSDoc コメントを読みやすい形式で表示できます。このレンダリングされたビューモードでは、アイテムは @ タグでグループ化されて表示されますが、タグ自体はスキップされます。参照先の Web ページを開いて、参照先のトピックのクイックドキュメントを表示し、読みやすくするためにフォントサイズを調整できます。

Rendered View for JSDoc comments
  • レンダリングされたビューモードに入るには、コメントの上にマウスを置き、余白の the Toggle Rendered View icon をクリックするか、Ctrl+Alt+Q を押します。アイコンが the Toggle Rendered View icon に変わります。

    Turn on the Rendered View mode
  • レンダリングされたビューモードを終了するには、ガターの the Toggle Rendered View icon をクリックするか、JSDoc コメントのコンテキストメニューからレンダリングビューの切り替えを選択するか、Ctrl+Alt+Q を押します。

    Turn the Rendered View mode off
  • 現在のファイルのすべての JSDoc コメントに対してレンダリングされたビューモードをオンにするには、ガターのコンテキストメニューからすべての Doc コメントをレンダリングを選択します。

    Render all comments in the current file
  • 必要に応じて、コンテキストメニューからフォントサイズの調整を選択し、スライダーを使用してフォントサイズを変更します。

    Adjust font size
  • デフォルトでレンダリングされるすべての JSDoc コメントを表示するには、設定ダイアログ(Ctrl+Alt+S)を開き、エディター | 一般 | 外観に移動して、ドキュメントコメントをレンダリングするチェックボックスを選択します。

    Turn on Rendered JSDoc comments by default
  • レンダリングビューのガターアイコンを非表示にするには、ガターのコンテキストメニューからガターアイコンの構成を選択し、開いた設定 | エディター | 一般 | ガターアイコンページのドキュメントコメントの直接描画チェックボックスをオフにします。

関連ページ:

JavaScript ドキュメントの検索

RubyMine は、標準の JavaScript API、プロジェクトとその依存関係からのシンボル、外部ライブラリで定義されたシンボルのリファレンスを示しています。ドキュメントポップアップでシンボルのドキュメントを表示し、リンクが利用可能な場合は外部サイトのドキュメントを開くことができます。プロジェクトシンボルまたはプロジェクト依存のシンボルの場合、RubyMine は対応する JSDoc コメントからドキュメントを生成します。標準の JavaScript オブジェクトまたはメソッドの場合、Ru...

TypeScript

RubyMine は、TypeScript ソースコードの開発、実行、デバッグをサポートします。RubyMine は .ts および .tsx ファイルを認識し、ユーザー側で追加の手順を行わなくても、編集するためのあらゆるコーディング支援を提供します。TypeScript ファイルには、アイコンが付いています。TypeScript 対応のコーディング支援には、キーワード、ラベル、変数、パラメーター、関数の補完、エラーと構文のハイライト、フォーマット、多数のコードインスペクションとクイックフィックス、および...

TODO コメント

時々、将来の参照のためにコードの一部をマークする必要があります: 最適化と改善の領域、起こり得る変更、議論される質問など。RubyMine を使用すると、エディターでハイライトされ、インデックスが付けられ、TODO ツールウィンドウにリストされる特別なタイプのコメントを追加できます。この方法で、あなたのチームメイトは注意が必要な問題を追跡できます。デフォルトでは、RubyMine によって認識される 2 つのパターン、とが小文字と大文字の両方で存在します。これらのパターンは行内で使用でき、サポート...

JavaScript ライブラリを構成する

言語と IDE のコンテキストでは、ライブラリはファイルまたはファイルのセットです。これらのファイルの関数とメソッドは、編集したプロジェクトコードから RubyMine が取得する関数とメソッドに加えて、RubyMine の内部知識に追加されます。プロジェクトのスコープでは、そのライブラリはデフォルトで書き込み保護されています。RubyMine は、2 つの事前定義された自動生成ライブラリフォルダーを予約します。node_modules プロジェクト package.json のオブジェクトにリストさ...