Lorsque vous écrivez du code pour un programme, il est facile de corriger tous les bogues et de le compiler correctement, mais il est beaucoup plus difficile pour une autre personne de le lire. Voici quelques conseils qui vous aideront à améliorer la lisibilité de votre code.

Pas

  1. 1 Les personnes qui maintiennent le code ne sont jamais aussi bien renseignées que l'auteur original. Ils peuvent avoir de plus faibles compétences en programmation et en savoir moins sur le projet. C'est la personne pour laquelle vous écrivez le programme. Vous voulez que le code soit facile pour cette personne.
  2. 2 Le fait qu'une fonctionnalité de langue soit disponible dans une langue ne signifie pas que vous devez l'utiliser. Le but est de communiquer ce que le code fait au lecteur suivant, et non de l’imprimer avec le nombre de lignes que vous pouvez prendre pour écrire du code.
  3. 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. 4 Référencez la norme de codage dans l'en-tête du fichier. Fournissez un fichier si possible que les outils peuvent s'ouvrir pour intégrer les paramètres corrects. Par exemple, Eclipse utilise par défaut des 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 vous devez disposer d'un fichier fournissant les paramètres appropriés pour un projet.
  5. 5 Utilisez des espaces blancs. Ignorer les lignes entre le code qui fait des choses différentes et utiliser des espaces après les points-virgules et les virgules. Cela rendra votre code plus propre et plus lisible.
  6. 6 Indentation entre accolades. Cela fait qu’il est évident qu’un morceau de code est séparé des autres. Cela peut aider lors de l'écriture d'une méthode longue. Si vous indiquez à l'intérieur si les instructions et les boucles le rendent facile à lire. Cette technique s'appelle l'imbrication, c'est-à-dire qu'elle montre qu'une partie du code est "imbriquée" dans une autre partie du code et permet au lecteur de suivre facilement le modèle d'imbrication.
  7. 7 Écrire des commentaires descriptifs. Supposez que la personne qui lit votre code ne sait rien de ce qu’elle est censée faire. Vos commentaires devraient expliquer chaque étape du processus. Tout vos algorithmes avancés, déroutants ou compliqués doivent être bien commentés. Essayez également de décrire le but du code. Par exemple, au lieu d'écrire "ajouter une à la variable", indiquez pourquoi cela est important dans le code, car tout le monde peut voir qu'il incrémente la variable, par exemple "incrémente le nombre de pages visitées de 1".
  8. 8 Rendez votre code "auto-documenté" en créant des noms d'objet descriptifs décrivant leurs objectifs. Les objets doivent référencer le domaine du problème ou des 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. 9 Inclure l'auteur d'origine et le responsable actuel du code dans le commentaire initial du fichier. Cela indique aux personnes à qui s'adresser pour réparer le code.
  10. 10 Commenter souvent Ecrire des commentaires pour indiquer votre intention. Si vous commentez votre code, quelqu'un supprimera vos commentaires.