Programmierhilfe

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Einführung in RAD Studio


Die Programmierhilfe (STRG+LEER) ist eine Code Insight-Funktion im Quelltext-Editor zur Vervollständigung Ihres Quelltextes.

Die Programmierhilfe wird in einem "Hinweisfenster" angezeigt, dessen Größe verändert werden kann. Es zeigt die gültigen Elemente, die Sie auswählen und in Ihren Quelltext einfügen können. Das Hinweisfenster enthält eine Liste, in der die ersten Symbole diejenigen sind, die mit dem eingegebenen Text beginnen, gefolgt von den Symbolen, die den Rest des Textes enthalten.

Sie können die Sortierung der Einträge in dem Hinweisfenster ändern, indem Sie mit der rechten Maustaste auf das Fenster klicken und Nach Namen sortieren oder Nach Bereich sortieren auswählen.

Die verschiedenen Elemente werden in einer speziellen Farbe und mit unterschiedlichen Formaten dargestellt. Zum Beispiel ist Folgendes standardmäßig festgelegt:

  • Schlüsselwörter sind dunkelblau.
  • Namen von Prozeduren, Funktionen und Eigenschaften sind schwarz und fett.
  • Beim Filtern werden die übereinstimmenden Zeichen unterstrichen dargestellt. (Kann ausgeschaltet werden).

Aufrufen der Programmierhilfe

Die Programmierhilfe ist standardmäßig aktiviert. Die Optionen zum Aktivieren und Deaktivieren der Programmierhilfe finden Sie unter Tools > Optionen > Editor > Sprache. Klicken Sie dann auf die Option Code Insight.

  • Wenn für die Programmierhilfe Automatisch aufrufen aktiviert ist, wird durch die Eingabe eines Punktes (.) und einer öffnenden Klammer (z. B. am Beginn eines Methodenaufrufs) die Programmierhilfe für Delphi und C++ aufgerufen.
  • Sie können in Delphi und C++ die Programmierhilfe immer mit STRG+LEER aufrufen, auch wenn die Option Automatisch aufrufen in den Code Insight-Optionen deaktiviert ist.
  • Wenn die Option Verzögerung in den Code Insight-Optionen aktiviert ist, wird die Programmierhilfe erst nach einer Verzögerung geöffnet (der Cursor dreht sich während der Wartezeit).

Für die Programmierhilfe für C++ unter macOS ist eine Compilierung erforderlich: Damit die Programmierhilfe funktioniert, muss Ihr C++-Desktop-Projekt für die macOS-Plattform mindestens einmal compiliert worden sein. Vergewissern Sie sich vor der Compilierung des Projekts, dass Ihre Umgebung alle Anforderungen erfüllt (siehe Konfigurieren der Entwicklungsumgebung für macOS).

Beim Compilieren des Projekts erstellt RAD Studio die vorcompilierte Header-Datei (wie z. B. myProject.pch) im Ordner C:\Users\<Benutzer>\Documents\Embarcadero\Studio\Projects\OSX32. Wenn Sie die Datei Projektname.pch versehentlich löschen, ist die Programmierhilfe für Ihr Projekt erst wieder verfügbar, wenn Sie das Projekt erneut compilieren.

Fenster der Programmierhilfe

In diesem Abschnitt wird das Fenster der Programmierhilfe für einen kleinen Codeblock erläutert. Angenommen in Ihrem Code ist eine Kollektion von Schaltflächen vorhanden.

var
  GViewButtons: TObjectList<TToolButton>;

In der Anwendung müssen Sie durch die Kollektion der Schaltflächen in einer for-Schleife iterieren, Sie kennen aber die Anzahl der Schaltflächen in der Kollektion nicht. Der zugehörige Codeblock sieht ungefähr wie folgt aus:

begin
  { ... }

  if Assigned(GViewButtons) then
    for I := 0 to GViewButtons. - 1 do
    begin
      { something }
    end;

  { ... }
end;

Setzen Sie den Cursor hinter den . (Punkt) nach der Anweisung GViewButtons, und drücken Sie STRG+LEER. Das Fenster der Programmierhilfe wird angezeigt:

CodeCOmpletionWindow10.4.1.png

Tipp: Sie können die Größe des Programmierhilfefensters mit der Maus ändern, indem Sie wie bei Standardfenstern an der rechten unteren Ecke ziehen.

Suchen Sie die Eigenschaft Count und drücken Sie EINGABE oder TAB. Der Code wird folgendermaßen vervollständigt:

begin
  { ... }

  if Assigned(GViewButtons) then
    for I := 0 to GViewButtons.Count - 1 do
    begin
      { something }
    end;

  { ... }
end;

Seit RAD Studio 12.0 enthält der Fußzeilenbereich im Fenster der Programmierhilfe Symbole, die Sie abhängig davon, wie Sie die Vervollständigung aufgerufen haben, anwenden können.

Typ Beschreibung

Annahmetasten

Gibt Tasten an, die das aktuell ausgewählte Element akzeptieren und in die Liste der Programmierhilfe einfügen.

Listennavigation

Gibt die Tasten an, mit denen die Auswahl in der Liste der Programmierhilfe geändert werden kann (Pfeilsymbole nach oben und unten).

Abbruch

Gibt Tasten an, die die Liste der Programmierhilfe schließen, ohne Code einzufügen.

Verwenden der Programmierhilfe

Sie können die Programmierhilfe in der IDE folgendermaßen verwenden:

  • Zum Anzeigen der Eigenschaften, Methoden und Ereignisse einer Klasse drücken Sie STRG+LEER nach dem Namen einer Variable, die entweder eine Klasseninstanz oder einen Zeiger auf eine Klasseninstanz darstellt. Wenn Automatisch aufrufen aktiviert ist, werden diese Elemente bei der Code-Eingabe automatisch angezeigt.
  • Zum Aufrufen der Programmierhilfe für einen Zeigertyp muss der Zeiger zuvor dereferenziert werden. Zum Beispiel:
    • In C++ geben Sie Folgendes ein: this->
    • In Delphi geben Sie Folgendes ein: type: Self.
  • Geben Sie einen Pfeil (->) für einen Zeiger auf ein Objekt ein.
  • Für Typen, die keine Zeiger sind, können Sie auch den Namen und einen Punkt (.) eingeben, um die Liste abgeleiteter und virtueller Eigenschaften, Methoden und Ereignisse anzuzeigen. Zum Beispiel:
    • In C++ geben Sie Folgendes ein: TRect test;test.
    • In Delphi geben Sie Folgendes ein: var test: TRect; begin test.
  • Geben Sie einen Zuweisungsoperator oder den Anfang einer Zuweisungsanweisung ein, und drücken Sie Ctrl+Space, um eine Liste der verfügbaren Werte für die Variable anzuzeigen.
  • Sie können die Programmierhilfe zur Vervollständigung der uses-Klausel (Delphi) oder von #include-Anweisungen (C++) in Units oder Dateien verwenden. Beachten Sie, dass die bereitgestellte Liste derzeit möglicherweise nicht alle Dateien oder Units enthält, die Sie erwarten:
    • Fügen Sie in Delphi in einer uses-Klausel ein Komma nach der letzten Unit hinzu und drücken Sie STRG+LEER. Um Units zu filtern, geben Sie die Anfangsbuchstaben ein.
    • Geben Sie in C++ "#include<" ein und drücken Sie STRG+LEER. Daraufhin wird eine Liste der bekannten Header angezeigt. Um Header zu filtern, geben Sie die Anfangsbuchstaben ein.
  • In C++ geben Sie den Zuweisungsoperator (::) ein.
  • Geben Sie einen Prozedur-, Funktions- oder Methodenaufruf ein, und drücken Sie STRG+LEER, um eine Liste der gültigen Argumente für die Zuweisung an die eingegebene Variable anzuzeigen. Wenn Sie einen Eintrag auswählen, auf den eine Ellipse (...) folgt, wird eine zweite Liste mit Argumenten geöffnet, die mit der in der Zuweisungsanweisung eingegebenen Variable kompatibel sind.
  • Geben Sie einen Record (in Delphi) oder eine Struktur (in C++) ein, um eine Liste der Felder anzuzeigen.
  • Geben Sie eine Array-Eigenschaft (kein genuines Array) ein, und drücken Sie STRG+LEER/code>, um einen Indexausdruck anzuzeigen.

  • <code> In C++ können Sie auch STRG+LEER in einer leeren Anweisungszeile drücken, um Symbole aus weiteren RTL-Units anzuzeigen, selbst wenn sie nicht von der aktuellen Unit verwendet werden.
  • In Delphi werden die reservierten Wörter im Fenster der Programmierhilfe angezeigt, wenn Sie Reservierte Wörter anzeigen im Dialogfeld Tools > Optionen > Editor > Sprache > Code Insight aktiviert haben. Die angezeigten Wörter sind von dem aktuellen Kontext abhängig, in dem die Programmierhilfe aufgerufen wird. Die aktuelle Liste mit den reservierten Wörtern in Delphi finden Sie in der Delphi-Sprachreferenz (Grundlegende syntaktische Elemente).

Abbrechen der Programmierhilfe oder Schließen des Fensters der Programmierhilfe

  • Um das Fenster der Programmierhilfe zu schließen, drücken Sie die Taste ESC oder klicken Sie auf eine beliebige Position außerhalb des Fensters.

Suchen einer Deklaration

Wenn das Fenster der Programmierhilfe angezeigt wird, können Sie die Taste <code>STRG</code> gedrückt halten und auf einen Bezeichner in der Liste klicken, um zu dessen Deklaration zu wechseln.

Wenn Sie im Quelltext-Editor den Mauszeiger über einen Bezeichner führen, wird in einem Hinweisfenster angegeben, wo der Bezeichner deklariert ist. Sie können <code>STRG</code> drücken, im Quelltext auf den Bezeichner zeigen (er wird blau unterstrichen und der Einfügepunkt wird als Hand angezeigt) und dann klicken, um zu dessen Deklaration zu wechseln.

Hinweis: Code Insight arbeitet nur in der Compilierungs-Unit. Die Programmierhilfe unterstützt WM_xxx-, CM_xxx- und CN_xxx-Botschaftsmethoden, basierend auf gleichnamigen Konstanten in den Units der <spanuses-Klausel.
Hinweis:

Wenn Sie den klassischen C++-Compiler verwenden, arbeitet die Programmierhilfe in C++ am besten, wenn Sie die Anwendung bereits erzeugt und einen vorcompilierten Header erstellt haben. Andernfalls müssen Sie warten, bis der Compiler die erforderlichen Informationen generiert hat. Es wird empfohlen, die Option VCH-Verwendung im Dialogfeld Projekt > Optionen > C++-Compiler Vorcompilierte Header zu aktivieren. Wählen Sie "Erzeugen und verwenden".

Wenn Sie den C++-Clang-Compiler verwenden, compiliert Code Insight jede C++-Datei eigenständig. Der vorcompilierte VCH-Header wird nicht verwendet. Die Programmierhilfe erfordert wohlgeformten C++-Code, der alles Benötigte einbezieht. Wenn eine Unit nicht alle Header einbezieht, auf die sie angewiesen ist, sondern davon ausgeht, dass der VCH sie indirekt einbezieht, kann Code Insight die Unit nicht analysieren und liefert keine Ergebnisse für die Programmierhilfe.

Sehen Sie sich die Ergebnisse der Fehlermarkierung ab dem Beginn der Datei an, um die Probleme zu lösen. Entsprechend den Fehlern können Sie eine Datei einbeziehen, wenn erforderlich, oder Ihren C++-Code verbessern.

Quelltext-Schlüsselwörter

Die Programmierhilfe enthält in der Liste der Programmierhilfe Sprachschlüsselwörter.

Beachten Sie, dass Schlüsselwörter automatisch vor Bezeichnern ausgewählt werden. Das bedeutet Folgendes: Auch wenn die Programmierhilfe automatisch aufgerufen wird, wird alles, was Sie eingeben, korrekt vervollständigt, solange es gültig ist.

Code Keywords.png

Sie können die Aufnahme von Schlüsselwörtern (reservierte Wörter) in die Liste der Programmierhilfe deaktivieren. Wir empfehlen, dass Sie in diesem Fall auch das automatische Aufrufen der Programmierhilfe deaktivieren und in Nur bei Punkt ändern.

Quelltextvorlagen

Quelltextvorlagen können so konfiguriert werden, dass sie nur in bestimmten Unit-Bereichen angezeigt werden, z. B. in einer Typdeklaration.

Tipp: Wenn Sie dies in Ihren Vorlagen verwenden möchten, fügen Sie das Flag "context" in einer Vorlage hinzu.
  • memberdecl: TFoo = class | end;
  • methoddecl: procedure | or function |
  • decl: var | or const |
  • typedecl: type |
  • methodbody: begin | end;
Das vertikale Balkensymbol ( | ) kennzeichnet eine Position, an der es angewendet werden kann, oder eine beliebige Position, an der es angewendet werden kann.
Warnung: Wenn eine Vorlage den gleichen Namen wie ein Schlüsselwort hat (z. B. "if"), wird die Vorlage standardmäßig nicht automatisch ausgewählt.

Siehe auch