Dans cet exercice, vous allez ajouter de la documentation à votre codage pour faciliter son utilisation.
Tâche 1: Copier modèle (facultatif)
Copiez la classe de modèle /LRN/CL_S4D401_EXS_CLASS. Si vous avez terminé l'exercice précédent, vous pouvez ignorer cette tâche et continuer à modifier votre classe ZCL_##_SOLUTION.
Étapes
Copiez la classe /LRN/CL_S4D401_EXS_CLASS dans une classe de votre propre package (nom proposé : ZCL_##_SOLUTION, ## correspondant à votre numéro de groupe).
Dans l'explorateur de projets, cliquez avec le bouton droit de la souris sur la classe /LRN/CL_S4D401_EXS_CLASS pour ouvrir le menu contextuel.
Dans le menu contextuel, sélectionnez Dupliquer....
Saisissez le nom de votre package dans la zone Package. Dans la zone Nom, saisissez ZCL_##_SOLUTION, où ## représente votre numéro de groupe.
Cliquez sur Next.
Confirmez l'ordre de transport et cliquez sur Terminer.
Activez la copie.
Appuyez sur Ctrl + F3 pour activer la classe.
Tâche 2: Ajouter documentation
Ajoutez la documentation ABAP Doc à la classe locale LCL_CARRIER et à la méthode Factory GET_INSTANCE.
Textes de documentation suggérés
| Type | Élément de code | Documentation |
|---|
| Classe locale | LCL_CARRIER | Compagnie aérienne - Une logique d'usine garantit qu'il ne peut y avoir qu'une seule instance pour chaque ID de transporteur. |
| Méthode | GET_INSTANCE | Méthode Factory - retourne une instance de cette classe. |
| Paramètre | i_carrier_id | Identification à trois caractères du transporteur. |
| Paramètre | r_result | Référence à l'instance - initial si l'instanciation a échoué. |
| Exception | ZCX_##_ÉCHEC | Échec de l'instanciation - Analysez le texte d'exception pour plus de détails. |
Étapes
Utilisez un correctif rapide pour ajouter la documentation ABAP Doc à la classe locale LCL_CARRIER.
Dans votre classe globale, naviguez jusqu'à la définition de la classe locale LCL_CARRIER.
Dans l'instruction CLASS … DEFINITION, placez le curseur sur lcl_carrier et appuyez sur Ctrl + 1 pour appeler les solutions rapides disponibles.
Dans la liste des solutions rapides disponibles, sélectionnez Ajouter ABAP Doc.
Résultat
Le correctif rapide ajuste le code comme suit :
12
CLASS lcl_carrier DEFINITION CREATE PRIVATE.
Gérez la documentation avec le texte de la table.
Astuce
Lorsque vous appuyez sur Entrée, l'éditeur insère une nouvelle ligne qui commence par "!.
Adaptez le code comme suit :
123
CLASS lcl_carrier DEFINITION CREATE PRIVATE.
Affichez les informations d'élément ABAP pour la classe locale LCL_CARRIER pour afficher l'édition.
Dans l'instruction CLASS … DEFINITION, placez le curseur sur lcl_carrier et appuyez sur F2 pour afficher les informations de l'élément.
Le texte ABAP Doc est affiché sous l'intitulé Documentation.
Utilisez un quickfix pour ajouter la documentation ABAP Doc à la méthode statique GET_INSTANCE de la classe locale LCL_CARRIER.
Dans la classe LCL_CARRIER, naviguez jusqu'à la définition de la méthode GET_INSTANCE.
Dans l'instruction CLASS-METHODS, placez le curseur sur get_instance et appuyez sur Ctrl + 1 pour appeler les solutions rapides disponibles.
Dans la liste des solutions rapides disponibles, sélectionnez Ajouter ABAP Doc.
Résultat
Le correctif rapide ajuste le code comme suit :
12345
CLASS-METHODS get_instance
Gérez la documentation de la méthode avec le texte de la table.
Adaptez le code comme suit :
12345
CLASS-METHODS get_instance
Gérez la documentation pour les paramètres de méthode et pour l'exception avec les textes de la table.
Adaptez le code comme suit :
12345
CLASS-METHODS get_instance
Affichez les informations d'élément ABAP pour la méthode GET_INSTANCE de la classe locale LCL_CARRIER pour afficher l'édition.
Dans l'instruction CLASS-METHODS, placez le curseur sur get_instance et appuyez sur F2 pour afficher les informations sur l'élément.
Les textes ABAP Doc sont affichés sous l'intitulé Documentation.
Tâche 3: Ajouter documentation formatée
Ajoutez la documentation ABAP Doc formatée pour la méthode FIND_PASSENGER_FLIGHT de la classe locale LCL_CARRIER. Le cas échéant, ajoutez une documentation ABAP Doc similaire pour la méthode FIND_CARGO_FLIGHT.
Textes de documentation suggérés
| Type | Élément de code | Documentation |
|---|
| Méthode | FIND_PASSENGER_FLIGHT | Recherchez un vol de passagers entre deux aéroports qui - est postérieur ou égal à une date donnée et
- a un nombre minimum de places disponibles restant
|
| Paramètre | i_airport_from_id | Aéroport de départ |
| Paramètre | i_airport_to_id | Aéroport d'arrivée |
| Paramètre | i_from_date | Première date de vol possible |
| Paramètre | i_places | Nombre minimum de places disponibles |
| Paramètre | e_flight | Vol trouvé (référence objet) |
| Paramètre | e_days_later | Nombre de jours après la date demandée |
Étapes
Utilisez un quickfix pour ajouter la documentation ABAP Doc à la méthode FIND_PASSENGER_FLIGHT de la classe locale LCL_CARRIER.
Dans la classe LCL_CARRIER, naviguez jusqu'à la définition de la méthode FIND_PASSENGER_FLIGHT.
Dans l'instruction METHODS, placez le curseur sur find_passenger_flight et appuyez sur Ctrl + 1 pour appeler les solutions rapides disponibles.
Dans la liste des solutions rapides disponibles, sélectionnez Ajouter ABAP Doc.
Résultat
Le correctif rapide ajuste le code comme suit :
12345678
METHODS find_passenger_flight
Gérez la documentation de la méthode avec le texte de la table. Assurez-vous de formater le vol de passagers comme texte fortement mis en évidence et d’utiliser une liste non triée pour les propriétés de vol.
Astuce
Vous n'avez pas à vous souvenir des directives de format par cœur. Appuyez sur Ctrl + Espace pour insérer une directive de format dans la saisie semi-automatique du code source.
Adaptez le code comme suit :
123456789101112
METHODS find_passenger_flight
Gérez la documentation des paramètres de méthode avec les textes de la table. Assurez-vous de mettre en forme Départ et Arrivée comme texte mis en évidence.
Adaptez le code comme suit :
123456789101112
METHODS find_passenger_flight
Affichez les informations d'élément ABAP pour la méthode FIND_PASSENGER_FLIGHT de la classe locale LCL_CARRIER pour voir l'édition.
Dans l'instruction METHODS, placez le curseur sur find_passenger_flight et appuyez sur F2 pour afficher les informations sur l'élément.
Les textes ABAP Doc sont affichés sous l'intitulé Documentation.
Facultatif : ajoutez une documentation ABAP Doc formatée similaire pour la méthode FIND_CARGO_FLIGHT.
Astuce
Copiez et collez la documentation ABAP Doc pour la méthode FIND_PASSENGER_FLIGHT et adaptez-la à la méthode FIND_CARGO_FLIGHT.
Adaptez le code comme suit :
123456789101112
METHODS find_cargo_flight
Tâche 4: Ajouter des liens
Ajoutez la documentation ABAP Doc suivante pour la classe locale LCL_FLIGHT :
Textes de documentation suggérés
| Type | Élément de code | Documentation |
|---|
| Classe locale | LCL_FLIGHT | Surclasse abstraite pour les classes lcl_passager_flight et lcl_cargo_flight Chaque instance est identifiée de manière unique par les attributs carrier_id, connection_id et flight_date. |
Ajoutez des liens à la documentation des sous-classes locales LCL_PASSENGER_FLIGHT et LCL_CARGO_FLIGHT et aux attributs publics carrier_id, connection_id et flight_date.
Étapes
Utilisez un correctif rapide pour ajouter la documentation ABAP Doc à la classe locale LCL_FLIGHT.
Dans votre classe globale, naviguez jusqu'à la définition de la classe locale LCL_FLIGHT.
Dans l'instruction CLASS … DEFINITION, placez le curseur sur lcl_flight et appuyez sur Ctrl + 1 pour appeler les solutions rapides disponibles.
Dans la liste des solutions rapides disponibles, sélectionnez Ajouter ABAP Doc.
Résultat
Le correctif rapide ajuste le code comme suit :
12
CLASS lcl_flight DEFINITION ABSTRACT.
Gérez la documentation avec le texte de la table.
Adaptez le code comme suit :
12345678
CLASS lcl_flight DEFINITION ABSTRACT.
Ajoutez un saut de ligne après lcl_cargo_flight.
Adaptez le code comme suit :
12345678
CLASS lcl_flight DEFINITION ABSTRACT.
Ajoutez un lien vers la documentation de la classe locale LCL_PASSENGER_FLIGHT et un lien vers la documentation de la classe locale LCL_CARGO_FLIGHT.
Remarque
Notez que cette documentation ABAP Doc se trouve au niveau de la classe globale et non dans la classe locale LCL_FLIGHT. Cela signifie qu'un signe point au début d'un lien s'adresse à la classe globale. Pour adresser une classe locale dans la même classe globale, vous devez placer un point devant le nom de la classe.
Adaptez le code comme suit :
12345678
CLASS lcl_flight DEFINITION ABSTRACT.
Ajoutez maintenant des liens aux attributs carrier_id, connection_id et flight_date de la classe locale LCL_FLIGHT.
Remarque
Si vous voulez référencer un attribut ou un autre objet de données dans un lien, vous devez insérer DATA : immédiatement avant le nom de l'objet.
Adaptez le code comme suit :
12345678
CLASS lcl_flight DEFINITION ABSTRACT.
Affichez les informations d'élément ABAP pour la classe locale LCL_FLIGHT pour afficher l'édition. Cliquez sur les liens pour vérifier qu'ils fonctionnent.
Dans l'instruction CLASS … DEFINITION, placez le curseur sur lcl_flight et appuyez sur F2 pour afficher les informations de l'élément.
Le texte ABAP Doc est affiché sous l'intitulé Documentation.
Enfin, activez votre code.
Appuyez sur Ctrl + F3 pour activer le code.
