Comment améliorer la lisibilité de votre code logiciel?

Pas de l'impressionner avec le peu de lignes que vous pouvez prendre pour écrire du code — Le but est de communiquer ce que fait le code au prochain lecteur, pas de l'impressionner avec le peu de lignes que vous pouvez prendre pour écrire du code.

Lors de l'écriture de code pour un programme, il est facile de corriger tous les bogues et de le faire compiler correctement, mais il est beaucoup plus difficile de faciliter la lecture par une autre personne. Voici quelques conseils qui vous aideront à améliorer la lisibilité de votre code.

Pas

1

Les personnes qui maintiennent le code ne sont jamais aussi bien versées que l'auteur original. Ils peuvent avoir des compétences de programmation plus faibles et en sauront moins sur le projet. Il s'agit de la personne pour laquelle vous écrivez le programme. Vous voulez que le code soit simple pour cette personne.
2

Ce n'est pas parce qu'une fonctionnalité linguistique est disponible dans une langue que vous devez l'utiliser. Le but est de communiquer ce que fait le code au prochain lecteur, pas de l'impressionner avec le peu de lignes que vous pouvez prendre pour écrire du code.
3

Souvent, un algorithme est difficile à suivre. Mais souvent, il est publié quelque part. Placez l'URI de la documentation de l'algorithme dans la section commentaire du code. Si l'URI pointe vers un emplacement éphémère, copiez les informations quelque part où le responsable du code peut les trouver.
4

Référencez la norme de codage dans l'en-tête du fichier. Fournissez si possible un fichier que les outils peuvent ouvrir pour incorporer les paramètres corrects. À titre d'exemple, Eclipse utilise par défaut les onglets, mais les onglets sont rendus différemment sur différents éditeurs de texte. L'utilisation d'espaces blancs au lieu d'onglets peut être préférable, mais avoir un fichier qui fournit les paramètres appropriés pour un projet.

Cela rend évident qu'un morceau de code est séparé d'un autre.
5

Utilisez un espace blanc. Sautez les lignes entre le code qui fait des choses différentes et utilisez des espaces après les points- virgules et les virgules. Cela rendra votre code plus propre et plus facile à lire.
6

Indentation à l'intérieur des accolades. Cela rend évident qu'un morceau de code est séparé d'un autre. Cela peut aider lors de l'écriture d'une méthode longue. L'indentation à l'intérieur des instructions et des boucles if facilitera la lecture. Cette technique s'appelle l'imbrication, c'est-à-dire qu'elle montre qu'un morceau de code est «imbriqué» dans un autre morceau de code, et permet au lecteur de suivre facilement le modèle d'imbrication.
7

Écrivez des commentaires descriptifs. Supposons que la personne qui lit votre code ne sache rien de ce qu'elle est censée faire. Vos commentaires doivent expliquer chaque étape du processus. Tous vos algorithmes avancés, déroutants ou compliqués doivent être bien commentés. Essayez également de décrire l'objectif du code. Par exemple, au lieu d'écrire «ajouter un à la variable», dites pourquoi c'est important dans le code, comme tout le monde peut le voir, il incrémente la variable, par exemple «incrémentez le nombre de pages consultées de 1».
8

Rendez votre code "auto-documenté" en créant des noms d'objet descriptifs qui décrivent leurs objectifs. Les objets doivent référencer le domaine du problème ou les artefacts logiciels standard. Une liste est une liste. Vous devrez peut-être créer une liste de clients qui sous-classe ou implémente une liste. Les variables et les paramètres de fonction doivent avoir des noms descriptifs.
9

Incluez l'auteur d'origine et le responsable actuel du code dans le commentaire initial du fichier. Cela indique aux gens à qui s'adresser pour réparer le code.
10

Commentez souvent. Écrivez des commentaires pour indiquer votre intention. Si vous commentez votre code, quelqu'un supprimera vos commentaires.

Le responsable actuel du code dans le commentaire initial du fichier — Incluez l'auteur d'origine et le responsable actuel du code dans le commentaire initial du fichier.

Conseils

Rendre votre code plus facile à lire vous aidera également à déboguer votre propre programme, ce qui vous facilitera la tâche.
Les variables constantes doivent être en majuscules, avec des mots séparés par un trait de soulignement. Les variables régulières doivent avoir les premières lettres de chaque mot en majuscules, en omettant les traits de soulignement.
Ajoutez des espaces blancs s'ils sont autorisés.
Si vous souhaitez commenter un gros morceau de texte, utilisez "/ *" pour démarrer le commentaire et "* /" pour le terminer. Ensuite, vous n'avez pas à écrire "//" sur chaque ligne. (Notez que les commentaires peuvent être différents dans d'autres langues)
Trouvez votre style d'écriture de code. Il existe une variété de styles que vous pouvez utiliser, tels que les exemples suivants: myVariable, MyVariable, myvariable, MYVARIABLE, My_Variable, MY_VARIABLE, my_variable, my_Variable, My_variable, etc. Assurez-vous d'affecter chaque style à un type spécifique tel que MY_VARIABLE pour les variables constantes et myVariable pour les variables régulières. Assurez-vous simplement de rester cohérent dans le style. Vous ne voulez pas finir par avoir à la fois des variables constantes myVariable et MY_VARIABLE.

Lisez aussi: Comment accéder à une console de serveur virtuel à l'aide de vCloud Director?