Passer en revue la solution de l’activité de défi sur l’amélioration de la lisibilité du code
Le code suivant est une solution possible pour le défi de l’unité précédente.
/*
This code reverses a message, counts the number of times
a particular character appears, then prints the results
to the console window.
*/
string originalMessage = "The quick brown fox jumps over the lazy dog.";
char[] message = originalMessage.ToCharArray();
Array.Reverse(message);
int letterCount = 0;
foreach (char letter in message)
{
if (letter == 'o')
{
letterCount++;
}
}
string newMessage = new String(message);
Console.WriteLine(newMessage);
Console.WriteLine($"'o' appears {letterCount} times.");
Ce code est simplement « une solution possible ». Vous avez peut-être utilisé des noms de variables différents, un autre espacement vertical et une indentation par tabulation différente. Voici la liste des modifications apportées.
- Une description générale de ce que tout ce code effectue est incluse au début, dans un commentaire multiligne. Vous pourriez considérer qu’il s’agit d’une petite amélioration par rapport aux commentaires de code d’origine. Cependant, étant donné la description du code pour le défi, il n’y avait pas beaucoup plus de contexte.
- Nous avons supprimé les commentaires individuels, car ils ne fournissaient pas d’informations réelles sur l’objectif ou la fonction du code.
- Nous avons ajouté plusieurs lignes vides pour améliorer la disposition du code. Regroupez les lignes de code qui semblent similaires ou qui fonctionnent ensemble pour accomplir une petite tâche.
- Nous avons ajouté des sauts de ligne et des tabulations pour améliorer l’apparence des instructions
foreachetif. - Nous avons appliqué les conventions de nommage des variables locales pour mieux communiquer l’objectif de chaque valeur.
Bravo si vous avez identifié les mêmes problèmes et que vous les avez traités d’une façon similaire ! Passez à la vérification des connaissances dans l’unité suivante.
Important
Si vous avez rencontré des difficultés pour relever ce défi, vous devriez peut-être passer en revue les unités précédentes avant de continuer.