In dieser Übung fügen Sie Ihrem Quelltext Dokumentation hinzu, um die Arbeit damit zu erleichtern.
Aufgabe 1: Vorlage kopieren (optional)
Kopieren Sie die Vorlagenklasse /LRN/CL_S4D401_EXS_CLASS. Wenn Sie die vorherige Übung abgeschlossen haben, können Sie diese Aufgabe überspringen und mit der Bearbeitung Ihrer Klasse ZCL_##_SOLUTION fortfahren.
Schritte
Kopieren Sie die Klasse /LRN/CL_S4D401_EXS_CLASS in eine Klasse in Ihrem eigenen Paket (Namensvorschlag: ZCL_##_SOLUTION, wobei ## für Ihre Gruppennummer steht).
Klicken Sie im Project Explorer mit der rechten Maustaste auf die Klasse /LRN/CL_S4D401_EXS_CLASS, um das Kontextmenü zu öffnen.
Wählen Sie im Kontextmenü Duplizieren....
Geben Sie den Namen Ihres Pakets in das Feld Package ein. Geben Sie im Feld NameZCL_##_SOLUTION ein, wobei ## für Ihre Gruppennummer steht.
Wählen Sie Next.
Bestätigen Sie den Transportauftrag, und wählen Sie Finish.
Aktivieren Sie die Kopie.
Drücken Sie Strg + F3, um die Klasse zu aktivieren.
Aufgabe 2: Dokumentation hinzufügen
Fügen Sie der lokalen Klasse LCL_CARRIER und der Factory-Methode GET_INSTANCEeine ABAP-Doc-Dokumentation hinzu.
Vorgeschlagene Dokumentationstexte
| Typ | Codeelement | Dokumentation |
|---|
| Lokale Klasse | LCL_CARRIER | Fluggesellschaft - Eine Factory-Logik stellt sicher, dass es für jede Spediteur-ID nur eine Instanz geben kann. |
| Methode | GET_INSTANCE | Factory-Methode - gibt eine Instanz dieser Klasse zurück. |
| Parameter | i_carrier_id | Dreistellige Identifikation des Frachtführers. |
| Parameter | r_result | Referenz auf die Instanz - initial, wenn die Instanziierung fehlgeschlagen ist. |
| Ausnahme | ZCX_##_FAILED | Instanziierung fehlgeschlagen - Details siehe Ausnahmetext. |
Schritte
Verwenden Sie eine Schnellkorrektur, um der lokalen Klasse LCL_CARRIEReine ABAP-Doc-Dokumentation hinzuzufügen.
Navigieren Sie in Ihrer globalen Klasse zur Definition der lokalen Klasse LCL_CARRIER.
Positionieren Sie in der Anweisung CLASS … DEFINITION den Cursor auf lcl_carrier, und drücken Sie Strg + 1, um die verfügbaren Quickfixes aufzurufen.
Wählen Sie aus der Liste der verfügbaren Quickfixes die Option ABAP-Doc hinzufügen.
Ergebnis
Die Schnellkorrektur passt den Code wie folgt an:
12
CLASS lcl_carrier DEFINITION CREATE PRIVATE.
Pflegen Sie die Dokumentation mit dem Text aus der Tabelle.
Hinweis
Wenn Sie die Eingabetaste drücken, fügt der Editor eine neue Zeile ein, die mit "! beginnt.
Passen Sie den Quelltext wie folgt an:
123
CLASS lcl_carrier DEFINITION CREATE PRIVATE.
Zeigen Sie die ABAP-Elementinformationen für die lokale Klasse LCL_CARRIER an, um die Ausgabe anzuzeigen.
Positionieren Sie in der Anweisung CLASS … DEFINITION den Cursor auf lcl_carrier, und drücken Sie F2, um die Elementinfo anzuzeigen.
Der ABAP-Doc-Text wird unter der Überschrift Dokumentation angezeigt.
Verwenden Sie eine Schnellkorrektur, um ABAP-Doc-Dokumentation zur statischen Methode GET_INSTANCE der lokalen Klasse LCL_CARRIER hinzuzufügen.
Navigieren Sie in der Klasse LCL_CARRIER zur Definition der Methode GET_INSTANCE.
Positionieren Sie in der Anweisung CLASS-METHODS den Cursor auf get_instance, und drücken Sie Strg + 1, um die verfügbaren Quickfixes aufzurufen.
Wählen Sie aus der Liste der verfügbaren Quickfixes die Option ABAP-Doc hinzufügen.
Ergebnis
Die Schnellkorrektur passt den Code wie folgt an:
12345
CLASS-METHODS get_instance
Pflegen Sie die Dokumentation zur Methode mit dem Text aus der Tabelle.
Passen Sie den Quelltext wie folgt an:
12345
CLASS-METHODS get_instance
Pflegen Sie die Dokumentation zu den Methodenparametern und zur Ausnahme mit den Texten aus der Tabelle.
Passen Sie den Quelltext wie folgt an:
12345
CLASS-METHODS get_instance
Zeigen Sie die ABAP-Elementinformationen für die Methode GET_INSTANCE der lokalen Klasse LCL_CARRIER an, um die Ausgabe anzuzeigen.
Positionieren Sie in der Anweisung CLASS-METHODS den Cursor auf get_instance, und drücken Sie F2, um die Elementinfo anzuzeigen.
Die ABAP-Doc-Texte werden unter der Überschrift Dokumentation angezeigt.
Aufgabe 3: Formatierte Dokumentation hinzufügen
Fügen Sie formatierte ABAP-Doc-Dokumentation für die Methode FIND_PASSENGER_FLIGHT der lokalen Klasse LCL_CARRIER hinzu. Fügen Sie optional eine ähnliche ABAP-Doc-Dokumentation für die Methode FIND_CARGO_FLIGHT hinzu.
Vorgeschlagene Dokumentationstexte
| Typ | Codeelement | Dokumentation |
|---|
| Methode | FIND_PASSENGER_FLIGHT | Suchen Sie nach einem Passagierflug zwischen zwei Flughäfen, die - auf oder nach einem bestimmten Datum liegt und
- hat eine Mindestanzahl verfügbarer Plätze übrig
|
| Parameter | i_airport_from_id | Abflugflughafen |
| Parameter | i_airport_to_id | Ankunftsflughafen |
| Parameter | i_from_date | Erstes mögliches Flugdatum |
| Parameter | i_sitze | Mindestanzahl verfügbarer Plätze |
| Parameter | e_flight | Gefundener Flug (Objektreferenz) |
| Parameter | e_days_later | Anzahl der Tage nach dem Wunschtermin |
Schritte
Verwenden Sie eine Schnellkorrektur, um der Methode FIND_PASSENGER_FLIGHT der lokalen Klasse LCL_CARRIEReine ABAP-Doc-Dokumentation hinzuzufügen.
Navigieren Sie in der Klasse LCL_CARRIER zur Definition der Methode FIND_PASSENGER_FLIGHT.
Platzieren Sie in der METHODS-Anweisung den Cursor auf find_passenger_flight, und drücken Sie Strg + 1, um die verfügbaren Quickfixes aufzurufen.
Wählen Sie aus der Liste der verfügbaren Quickfixes die Option ABAP-Doc hinzufügen.
Ergebnis
Die Schnellkorrektur passt den Code wie folgt an:
12345678
METHODS find_passenger_flight
Pflegen Sie die Dokumentation zur Methode mit dem Text aus der Tabelle. Stellen Sie sicher, dass Sie den Passagierflug als stark hervorgehobenen Text formatieren, und verwenden Sie eine unsortierte Liste für die Flugeigenschaften.
Hinweis
Sie müssen sich nicht auswendig an die Formatanweisungen erinnern. Drücken Sie Strg + Leertaste, um eine Formatanweisung über die Quelltextvervollständigung einzufügen.
Passen Sie den Quelltext wie folgt an:
123456789101112
METHODS find_passenger_flight
Pflegen Sie die Dokumentation zu den Methodenparametern mit den Texten aus der Tabelle. Stellen Sie sicher, dass Sie Abfahrt und Ankunft als hervorgehobenen Text formatieren.
Passen Sie den Quelltext wie folgt an:
123456789101112
METHODS find_passenger_flight
Zeigen Sie die ABAP-Elementinformationen für die Methode FIND_PASSENGER_FLIGHT der lokalen Klasse LCL_CARRIER an, um die Ausgabe anzuzeigen.
Positionieren Sie in der Anweisung METHODS den Cursor auf find_passenger_flight, und drücken Sie F2, um die Elementinfo anzuzeigen.
Die ABAP-Doc-Texte werden unter der Überschrift Dokumentation angezeigt.
Optional: Fügen Sie eine ähnliche formatierte ABAP-Doc-Dokumentation für die Methode FIND_CARGO_FLIGHT hinzu.
Hinweis
Kopieren Sie die ABAP-Doc-Dokumentation für die Methode FIND_PASSENGER_FLIGHT, fügen Sie sie ein, und passen Sie sie an die Methode FIND_CARGO_FLIGHT an.
Passen Sie den Quelltext wie folgt an:
123456789101112
METHODS find_cargo_flight
Aufgabe 4: Links hinzufügen
Fügen Sie die folgende ABAP-Doc-Dokumentation für die lokale Klasse LCL_FLIGHT hinzu:
Vorgeschlagene Dokumentationstexte
| Typ | Codeelement | Dokumentation |
|---|
| Lokale Klasse | LCL_FLIGHT | Abstrakte Oberklasse für die Klassen lcl_passenger_flight und lcl_cargo_flight Jede Instanz wird durch die Attribute carrier_id, connection_id und flight_date eindeutig identifiziert. |
Fügen Sie Links zur Dokumentation der lokalen Unterklassen LCL_PASSENGER_FLIGHT und LCL_CARGO_FLIGHT sowie zu den öffentlichen Attributen carrier_id, connection_id und flight_date hinzu.
Schritte
Verwenden Sie eine Schnellkorrektur, um ABAP-Doc-Dokumentation zur lokalen Klasse LCL_FLIGHT hinzuzufügen.
Navigieren Sie in Ihrer globalen Klasse zur Definition der lokalen Klasse LCL_FLIGHT.
Positionieren Sie in der Anweisung CLASS … DEFINITION den Cursor auf lcl_flight, und drücken Sie Strg + 1, um die verfügbaren Quickfixes aufzurufen.
Wählen Sie aus der Liste der verfügbaren Quickfixes die Option ABAP-Doc hinzufügen.
Ergebnis
Die Schnellkorrektur passt den Code wie folgt an:
12
CLASS lcl_flight DEFINITION ABSTRACT.
Pflegen Sie die Dokumentation mit dem Text aus der Tabelle.
Passen Sie den Quelltext wie folgt an:
12345678
CLASS lcl_flight DEFINITION ABSTRACT.
Fügen Sie nach lcl_cargo_flight einen Zeilenumbruch ein.
Passen Sie den Quelltext wie folgt an:
12345678
CLASS lcl_flight DEFINITION ABSTRACT.
Fügen Sie einen Link zur Dokumentation der lokalen Klasse LCL_PASSENGER_FLIGHT und einen Link zur Dokumentation der lokalen Klasse LCL_CARGO_FLIGHT hinzu.
Notiz
Beachten Sie, dass diese ABAP-Doc-Dokumentation auf globaler Klassenebene und nicht innerhalb der lokalen Klasse LCL_FLIGHT liegt. Das bedeutet, dass ein Punkt am Anfang einer Verknüpfung die globale Klasse adressiert. Um eine lokale Klasse derselben globalen Klasse anzusprechen, muss dem Klassennamen ein Punkt vorangestellt werden.
Passen Sie den Quelltext wie folgt an:
12345678
CLASS lcl_flight DEFINITION ABSTRACT.
Fügen Sie nun Links zu den Attributen carrier_id, connection_id und flight_date der lokalen Klasse LCL_FLIGHT hinzu.
Notiz
Wenn Sie ein Attribut oder ein anderes Datenobjekt in einer Verknüpfung referenzieren möchten, müssen Sie DATA: unmittelbar vor dem Objektnamen einfügen.
Passen Sie den Quelltext wie folgt an:
12345678
CLASS lcl_flight DEFINITION ABSTRACT.
Zeigen Sie die ABAP-Elementinformationen für die lokale Klasse LCL_FLIGHT an, um die Ausgabe anzuzeigen. Wählen Sie die Links, um zu überprüfen, ob sie funktionieren.
Positionieren Sie in der Anweisung CLASS … DEFINITION den Cursor auf lcl_flight, und drücken Sie F2, um die Elementinfo anzuzeigen.
Der ABAP-Doc-Text wird unter der Überschrift Dokumentation angezeigt.
Aktivieren Sie abschließend Ihren Quelltext.
Drücken Sie Strg + F3, um den Quelltext zu aktivieren.
