Présentation
Le code que vous écrivez doit communiquer votre intention à la fois au compilateur et aux autres développeurs qui peuvent avoir besoin de le lire. Le plus souvent, vous lirez vous-même le code que vous avez développé, parfois des mois après l’avoir écrit. Il est donc dans votre intérêt d’écrire du code clair et facile à comprendre. N’oubliez pas que si vous écrivez le code une seule fois, vous serez amené à le lire à de nombreuses reprises.
Supposons que vous soyez chargé d’écrire du code pour un autre groupe de développeurs. Vous les rencontrez pour discuter de la spécification et l’affectation est claire. Après la réunion, ils vous indiquent que vous travaillerez de manière indépendante pendant le développement. Quand vous aurez terminé, vous transmettrez votre code à l’autre groupe. Vous disposez des compétences nécessaires pour exécuter la tâche de programmation, mais vous n’aviez encore jamais eu besoin d’écrire du code qui sera géré par d’autres personnes. L’équipe vous dit que tant que vous suivez les conventions de programmation standard pour C#, il ne devrait pas y avoir de problème. Vous prévoyez de passer en revue les conventions de programmation en C# applicables au code sur lequel vous allez travailler.
Dans ce module, vous allez apprendre à choisir pour vos variables des noms décrivant leur objectif et leur intention. Vous allez découvrir comment ajouter des commentaires de code pour documenter les spécifications générales et l’approche que vous adoptez dans le code et pour indiquer temporairement au compilateur d’ignorer certaines lignes de code. Enfin, vous allez découvrir comment utiliser des espaces pour indiquer la relation entre des lignes de code individuelles.
À la fin de ce module, vous écrirez du code avec une intention plus affirmée, en vous concentrant sur la lisibilité et la qualité du code pour communiquer à la fois avec le compilateur et avec d’autres développeurs.
Important
Ce module contient des activités de programmation qui nécessitent Visual Studio Code. Vous devez avoir accès à un environnement de développement sur lequel Visual Studio Code est installé et configuré pour le développement d’applications C#.
Objectifs d’apprentissage
Dans ce module, vous allez :
- Choisir un nom descriptif pour les variables, qui décrit leur objectif et leur intention.
- Utiliser des commentaires de code pour indiquer temporairement au compilateur d’ignorer des lignes de code.
- Utiliser des commentaires de code pour décrire des spécifications générales ou un objectif pour un passage de code.
- Écrire du code qui utilise efficacement des espaces blancs pour refléter la relation entre les lignes de code.
Prérequis
- Savoir utiliser Visual Studio Code pour créer et exécuter des applications console simples
- Savoir imprimer des messages dans la console à l’aide de
Console.WriteLine() - Savoir utiliser les
ifinstructions etelse ifpour créer des branches de code