AppCode 2023.1 ヘルプ

コードリファレンス情報

パラメーター情報

パラメーター情報ポップアップには、メソッドおよび関数呼び出しのパラメーターの名前が表示されます。AppCode は、エディターで左括弧を入力するか、候補リストからメソッドを選択してから 1 秒(1000 ミリ秒)以内に、使用可能なすべてのメソッドシグネチャーを含むポップアップを自動的に表示します。

ポップアップが閉じている場合、または IDE がポップアップを自動的に表示しないように構成されている場合は、ポップアップを明示的に呼び出すことができます。これを行うには、Ctrl+P を押します(または表示 | パラメーター情報をクリックします)。

Parameter info popup

完全なメソッドまたは関数のシグネチャーを表示する

デフォルトでは、パラメーター情報ポップアップには簡単なシグネチャーが表示されます。メソッド名と返される型を含む完全なシグネチャーを表示するように IDE を設定できます。

  • 環境設定ダイアログ(Ctrl+Alt+S)で、エディター | 一般 | コード補完に移動し、完全なメソッドシグネチャーを表示するチェックボックスを選択します。

    Full signatures enabled

パラメーター情報ポップアップを設定する

  1. 環境設定ダイアログ(Ctrl+Alt+S)で、エディター | 一般 | コード補完に進みます。

  2. パラメーター情報のポップアップをミリ秒単位で表示するフィールドに、ポップアップが表示されるまでの時間をミリ秒単位で指定します。

ポップアップが自動的に表示されないようにするには、パラメーター情報のポップアップをミリ秒単位で表示するチェックボックスをオフにします。

インレイヒント

インレイヒントは、エディターに表示される特別なマーカーであり、呼び出されたメソッドが期待するパラメーターの名前など、コードに関する追加情報を提供します。他の型のヒントは、アノテーション、メソッドのパラメーター、使用箇所などについて通知します(言語によって異なります)。

Parameter hints shown

インレイヒントの構成

  • 環境設定 | エディター | インレイヒントに移動します。または、ヒントを右クリックしてヒント設定を選択します。

Swift のインレイヒント

Swift では、タイプヒントとエラーヒントの 2 種類のインラインヒントを有効にできます。

タイプヒントを表示

型ヒントは、明示的な型アノテーションなしで宣言された変数の型を示します。

  1. 開いているファイルに型ヒントを表示するには、エディターがフォーカスされていることを確認し、メインメニューから表示 | アクティブエディター | タイプヒントを表示を選択します。

  2. すべてのファイルに型ヒントを表示するには、環境設定ダイアログ(Ctrl+Alt+S)で、エディター | 一般 | 外観に移動し、Swift タイプのヒントを表示チェックボックスを選択します。この設定は、すべてのプロジェクトのすべての Swift ファイルに適用されます。

  3. 変数宣言に明示的な型を追加する場合は、変数にキャレットを置き、Alt+Enter を押して、明示的なタイプを追加 インテンションアクションを選択します。

    Add explicit type intention action
  4. このインテンションアクションが使用できない場合は、設定 | エディター | インテンション | Swift で有効にします。

エラーヒントを表示

エラーヒントは、関数 / メソッドの宣言と呼び出しの横に表示され、関数 / メソッドがスローできるすべてのエラーを表示します。

  1. 開いているファイルにエラーヒントを表示するには、エディターがフォーカスされていることを確認し、メインメニューから表示 | アクティブエディター | タイプヒントを表示を選択します。

  2. すべてのファイルにエラーヒントを表示するには、環境設定ダイアログ(Ctrl+Alt+S)で、エディター | 一般 | 外観に移動し、Swift タイプのヒントを表示チェックボックスを選択します。この設定は、すべてのプロジェクトのすべての Swift ファイルに適用されます。

Swift error hints shown

呼び出すメソッドに複数の実装 / オーバーライドがある場合、AppCode は、これらの実装 / オーバーライドでスローされる可能性があるすべての既知のエラーのヒントを表示します。

非最終パブリックプロトコルおよびオープンクラスのオープンメソッドの場合、記号がエラーヒントに表示されます。これは、コンパイル時に不明なエラーがオーバーライドでスローされる可能性があることを意味します。

エラー名の横にある下矢印は、エラーがメソッドの本体ではなく、メソッドのオーバーライドまたは実装でスローされることを示します。

ヒントの外観を構成する

Swift のエラーと型ヒントの表示方法を変更できます。

  1. 環境設定ダイアログ(Ctrl+Alt+S)で、エディター | カラースキームの切り替え | Swift に進みます。

  2. リストでインラインヒント | エラーヒントまたはインラインヒント | 型ヒントを見つけます。前景色や背景色、エフェクトなど、変更するパラメーターを調整します。プレビューでは、ヒントがどのように見えるかを確認できます。

クイックドキュメント

クイックドキュメント機能を使用すると、エディターから任意のシンボルの情報をすばやく取得できます。コード要素の上にマウスを置くと、ポップアップにコードドキュメントが表示されます。シンボルは、サポートされているマークアップまたは SDK ドキュメントに従って作成されたドキュメントコメントとともに提供する必要があることに注意してください。

ポップアップのクイックドキュメント

ポップアップでクイックドキュメントを表示

  • エディターで必要なシンボルの上にマウスを置きます。

  • キャレットをシンボルに置き、Ctrl+Q表示 | クイックドキュメント)を押します。

    Ctrl+Q をもう一度押して、ドキュメントツールウィンドウでこのドキュメントを開きます。

ポップアップで the Show Options Menu icon をクリックしてフォントサイズを変更するか、クイックドキュメントツールバーを表示するか、ソースコードに移動します。

ホバー時にクイックドキュメントを無効にする

デフォルトでは、コード要素の上にマウスを置くと、クイックドキュメントポップアップが表示されます。クイックドキュメント機能を明示的に呼び出した後にのみポップアップを表示するように IDE を構成できます。

  • ポップアップで the Show Options Menu icon をクリックし、マウス移動時に表示するオプションを無効にします。

  • 環境設定ダイアログ(Ctrl+Alt+S)で、エディター | コード編集 | クイックドキュメントに移動し、ホバー時にクイックドキュメントを表示するチェックボックスをオフにします。

この場合、キャレットでシンボルのドキュメントを表示するには、Ctrl+Q を押すか、メインメニューから表示 | クイックドキュメントを選択します。ドキュメントはポップアップで表示されますが、ツールウィンドウにすぐに表示されるように IDE を設定できます。

ツールウィンドウのクイックドキュメント

ツールウィンドウでドキュメントを表示する

デフォルト設定では、Ctrl+Q表示 | クイックドキュメント)を押すと、ポップアップでクイックドキュメントが開きます。設定を変更して、ツールウィンドウにドキュメントを表示できます。

  • クイックドキュメントポップアップで、the Show Options Menu icon をクリックし、ドキュメントのポップアップを前に表示オプションを無効にします。

  • ドキュメントツールウィンドウで、ツールウィンドウツールバーの Show Options Menu アイコンをクリックし、ドキュメントのポップアップを前に表示オプションを無効にします。

外部ドキュメント

外部ドキュメントは、Web ブラウザーで必要な情報を開くため、関連するシンボルに移動し、同時にさらに参照できるように情報を保持できます。外部ドキュメントアクションは、あなたの Web またはオフラインブラウザーで選択したシンボルのための Apple デベロッパドキュメント(英語)を開き選択肢

外部ドキュメントの参照

外部ブラウザーのキャレットでシンボルのドキュメントを開くには、次のいずれかを実行します。

  • Shift+F1 を押します。

  • メインメニューから表示 | 外部ドキュメントを選択します。

  • クイックドキュメント Ctrl+Q ポップアップのリンクをクリックします。

    The link to external documentation

外部ドキュメントブラウザーを選択する

外部ドキュメントを開く場所を選択するには:

  1. 環境設定ダイアログ(Ctrl+Alt+S)で、エディター | 外部ドキュメントに進みます。

  2. 次のオプションのいずれかを選択してください:

    • デフォルト Web ブラウザー(デフォルト): デフォルトの Web ブラウザー。

    • ダッシュ : オフライン API ドキュメント用のダッシュ(英語)ブラウザー(コンピューターにインストールされている場合)。

    • Xcode ドキュメント : オフラインの Xcode ドキュメントビューアー。

コンテキスト情報

現在のメソッドまたはクラス宣言が表示されていない場合は、エディターの左上隅に表示されるツールチップで表示できます。これを行うには、Alt+Q を押すか、メインメニューから表示 | コンテキスト情報を選択します。

View context info