🔍 Revue de code

[boisgera]

“Any fool can write code that a computer can understand. Good programmers write code that humans can understand.”

― Martin Fowler

Les trois code suivants comportent un tracé de damier qui marche :

• Louis snake.py (commit 746172dbfe)

• Yoan damier.py (commit 16549167e8)

• Blanche snake.py (commit 8d1966dc8f)

Lisez les 3 portions du code qui tracent les damiers. Lequel vous semble le plus facile à comprendre ? (c'est subjectif, il n'y a pas de "bonne" réponse dans l'absolu). Sauriez-vous dire pourquoi ? Avez-vous des suggestions d'améliorations (en tout cas, des modifications du code qui auraient facilité votre compréhension) ?

Répondez dans ce fil de discussion svp !

[clemence64300]

Celui de Blanche : clair car il comporte une fonction à l'extérieur du code principal, ce qui allège. C'est celui que j'ai compris le plus rapidement, même si j'ai eu besoin d'un peu de temps.
Celui de Yoan : j'ai eu un peu plus de mal à comprendre, mais la manière de coder est assez naturelle finalement. J'aurais mis la ligne #8 entre la #13 et la #14, je voyais pas où on définissait le x pour entrer dans la boucle for.
Celui de Louis : idem que pour Yoan, une fois qu'on a compris le principe on comprend la logique de coder de cette manière. J'aurais mis le #36 entre le #42 et #43. Peut-être qu'il faudrait sauter des lignes un peu plus souvent ?

[PaulETIENNE-GOURVES]

Code de Blanche : Le code est agréable à lire et respecte assez bien PEP8. La fonction is_white définie hors de la boucle est bienvenue, on comprend assez bien la démarche, même si on aurait pu alléger la fonction en utilisant la condition (i + j) % 2 == 0 pour éviter le elif. Faire varier directement i et j dans la boucle for et tracer des carrés de 30x30 plutôt que pixel par pixel aurait été plus lisible (et moins gourmand en calcul).

Code de Yoan : Qu'il n'y ait pas de commentaire ou de fonction discriminant cases noires et blanches hors des boucles rend la compréhension plus difficile. Remplir l'arrière-plan en blanc avec screen.fill puis tracer par dessus les carrés noirs aurait économisé une double boucle for et allégé le code.

Code de Louis : La méthode utilisée parait assez naturelle et se comprend assez bien. Pas de saut de ligne, et les conventions PEP8 ne sont pas respectées partout, ce qui fait que le code n'est pas très aéré et difficile à lire. Il est difficile de délimiter la partie qui sert vraiment à tracer le damier.

Pour les trois codes, des petits commentaires dans le code auraient permis de comprendre plus vite les différentes étapes de la démarche.

[GNRNicolas]

Pour le code de Louis et Yoan il serait plus agréable de le lire s'il y avait plus d'espaces et de distinction entre les parties du codes qui ont chacune leur rôle, on pourrait y ajouter un commentaire rapide avant la partie pour dire ce qu'elle va faire.
Pour le code de Blanche j'aime bien la méthode à laquelle je n'avais pas pensé, c'est assez rapide et séparer le problème en plus petits problème avec des fonctions plus simple est une bonne idée.

[Florine353]

Code de Blanche : l'ajout de fonctions permet au code une meilleure lisibilité, tout comme les sauts de lignes. La méthode utilisée n'est pas la plus naturelle mais est très efficace.

Code de Yoan : le code est moins lisible que celui de Blanche, il aurait été préférable de mettre plus de d'espaces, et d'ajouter des commentaires. Le code me parait assez lourd et peu efficace, il y a plusieurs fois deux boucles for imbriquées.

Code de Louis : sa manière de coder parait assez naturelle une fois que l'on a compris le code, mais elle n'est pas très lisible et mériterait des commentaires pour mieux expliquer toutes les étapes, en particulier pour une personne qui n'aurait pas travaillé sur le projet. Il est difficile de distinguer les différentes parties du code

[timotheedol]

code de Louis : Après avoir relu le code, je crois avoir compris la démarche.
Des sauts de lignes et des commentaires pourraient permettre de comprendre plus vite la démarche.

code de Yoan : idem que pour Louis

code de Blanche : Le code est très clair. La fonction is_white a un nom explicite et témoigne bien de la démarche adoptée.
On peut peut-être condenser is_white en faisant le test: if i + j % 2 ==0
pour moi, c'est la plus naturelle des 3 méthodes

[MatthieuLam]

Le code de Blanche me parait le plus clair. Il n'est pas trop long et va à l’essentiel. Pour les autres, j'aurais mieux compris si les parties étaient mieux séparées, avec des commentaires par exemple.