Comment gérer les erreurs (utilisateurs) ? - Qualité de Développement

D’abord, un point sur Git.

Structure de donnée de l’historique Git¶

Gestion des erreurs¶

Programmation robuste¶

Les principes de la programmation robuste

Soyez paranoïaque : L’utilisateur, volontairement ou non, mettra votre code à l’épreuve. Il est essentiel de prévoir ses actions pour éviter les comportements imprévus.
Ils sont stupides : Les messages d’erreur doivent être clairs, bienveillants et fournir les informations nécessaires pour que l’utilisateur puisse corriger l’erreur lui-même : explication concise, lien vers la documentation si besoin, et suggestions de correction.
Ils sont dangereux : L’utilisateur ne doit pas avoir à manipuler directement le code source. Il doit pouvoir accomplir ses tâches uniquement avec les fonctionnalités mises à sa disposition.
Rien n’est impossible : Ne supposez jamais qu’une condition sera toujours respectée. Concevez votre code comme une machine, si une erreur peut techniquement arriver alors elle arrivera forcément.

Input validation¶

Pour certaines erreurs, il n’est pas nécessaire d’arrêter l’exécution du programme et il suffit de valider l’entrée de l’utilisateur avant de passer à l’étape suivante.

#include <iostream>
#include <limits> // for numeric_limits
#include <stdexcept>

int getPositiveInteger() {
    int userInput;
    int attempts = 0;
    const int maxAttempts = 5;

    while (attempts < maxAttempts) {
        std::cout << "Enter a positive integer: ";
        std::cin >> userInput;

        if (std::cin.fail() || userInput <= 0) { // cin.fail() is true if user inputs non-integer value or the value is too large
            std::cin.clear(); // cin.clear() resets the state of cin if it was in fail state
            std::cin.ignore(std::numeric_limits<std::streamsize>::max(), '\n'); // Clear the buffer until it reaches end of line character '\n'.
            attempts++;
            std::cout << "Invalid input. Please try again. For example: 1" << std::endl;
            std::cout << maxAttempts - attempts << " left." << std::endl;
        } else {
            return userInput;
        }
    }
    
    // Explained below
    throw std::invalid_argument("Maximum attempts reached.");
}

try, throw, catch¶

Syntaxe d’un gestionnaire d’erreurs

#include <stdexcept> // for standard exceptions

try {
  //Code to try
  //...
  
  //Throw an exception when encoutering user error
  throw(std::exception("Error message")); 
} catch (const std::exception& error) {
  // Code to handle errors
  //...
}

Example :

#include <iostream>
#include <limits>
#include <stdexcept>
#include <cstdlib> // for exit

int getPositiveInteger() {
    //...

    throw std::invalid_argument("Maximum attempts reached.");
}

void processUserInput() {
    try {
        int number = getPositiveInteger();
        // ...

        // Example of another throw
        throw std::runtime_error("Some error message here.");

    } catch (const std::invalid_argument& error) {
        // Output the error message (error.what()) on the cerr stream (for errors)
        std::cerr << "Error: " << error.what() << std::endl; // Output: Error: Maximum attempts reached.
        exit(EXIT_FAILURE);
    } catch (const std::runtime_error& error) {
        std::cerr << "Error: " << error.what() << std::endl;
        // Possibly handles error gracefully without exiting
    }
}

null, c’est nul !

Il faut éviter d’utiliser nullptr en C++ (null en Java et C#). Vous allez passer votre temps à vérifier si un objet est nullptr et cela rend le code illisible.

Exemple:

void registerItemInStore(Item* item, Store store) {
    if (item != nullptr) {
        ItemRegistry* registry = store.getItemRegistry();
        if (registry != nullptr) {
            Item* existing = registry->getItem(item->getID());
            if (existing->getBillingPeriod().hasRetailOwner()) {
                existing->register(item);
            }
        }
    }
}

Est-ce que vous avez remarqué que l’on n’a pas vérifié si existing est nullptr ?

Cours

Quand faut-il documenter ou commenter ?

Cours

Comment tester le code ?