IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

Débats sur le développement - Le Best Of Discussion :

Programmation : quand faut-il commenter son code ? Google s’invite dans le débat


Sujet :

Débats sur le développement - Le Best Of

  1. #141
    Expert éminent sénior
    Avatar de Mat.M
    Profil pro
    Développeur informatique
    Inscrit en
    Novembre 2006
    Messages
    8 361
    Détails du profil
    Informations personnelles :
    Localisation : France, Rhône (Rhône Alpes)

    Informations professionnelles :
    Activité : Développeur informatique

    Informations forums :
    Inscription : Novembre 2006
    Messages : 8 361
    Points : 20 379
    Points
    20 379
    Par défaut
    salut el_slapper 9 et 10 pour moi ça ne veut rien dire; ce n'est pas du tout explicite

  2. #142
    Expert éminent sénior
    Profil pro
    Inscrit en
    Décembre 2007
    Messages
    6 803
    Détails du profil
    Informations personnelles :
    Localisation : France, Hérault (Languedoc Roussillon)

    Informations forums :
    Inscription : Décembre 2007
    Messages : 6 803
    Points : 32 058
    Points
    32 058
    Par défaut
    Citation Envoyé par Mat.M Voir le message
    salut el_slapper 9 et 10 pour moi ça ne veut rien dire; ce n'est pas du tout explicite
    Ah, je comprends ce que tu veux dire, ça ouvre un autre débat. Le truc, c'est que quand on est sur l'application, c'est explicite : 9, c'est "autres", et 10, c'est "SMUR". (on a aussi ambulances, hélicos, véhicule personnel, pompiers, etc.....). Est-ce que ça a de la valeur ajoutée de créer une liste qui fait correspondre le code à sa valeur? Pour l'appli elle-même, évidemment. If codeTransportSMUR(ou un équivalent explicite), est bien plus lisible que If codeTransport = 10. On est d'accord.

    Mais je ne suis pas coté applicatif. Je suis coté script de test automatique, et, au final, que 10 signifie SMUR, je m'en fous. A la maintenance du script, ça n'a aucune valeur ajoutée. Faut-il le mettre quand même? Mmmmh, bonne question. L'action que j'essaye de coder(entretemps, j'ai fini par la faire marcher, d'ailleurs), c'est juste de choisir la valeur "10" dans cet ActiveX piégeux. Je ne peux pas décemment mettre une valeur "SMUR" (d'autant plus que ça ne marcherait pas, puisque quand le robot tape deux chiffres, ça ne prend que le dernier, et que le code SMUR est sur deux chiffres, à moins de faire une usine à gaz pour un truc que je fais une fois en tout et pour tout).

    Dit autrement, est-ce que ça vaut le cout de surarchitecturer le truc avec une fonction complexe que je ne rappellerais jamais ailleurs(j'en suis à peu près certain), juste pour que le code soit limpide et n'aie pas besoin de commentaires(suite à ta remarque, je crois que je vais juste rajouter un commentaire qui dit que 10="SMUR")? Vaste question. Je ne vais pas le faire, mais je sais que certains me le préconiseraient.
    Les 4 règles d'airain du développement informatique sont, d'après Michael C. Kasten :
    1)on ne peut pas établir un chiffrage tant qu'on a pas finalisé la conception
    2)on ne peut pas finaliser la conception tant qu'on a pas complètement compris toutes les exigences
    3)le temps de comprendre toutes les exigences, le projet est terminé
    4)le temps de terminer le projet, les exigences ont changé
    Et le serment de non-allégiance :
    Je promets de n’exclure aucune idée sur la base de sa source mais de donner toute la considération nécessaire aux idées de toutes les écoles ou lignes de pensées afin de trouver celle qui est la mieux adaptée à une situation donnée.

  3. #143
    Expert éminent sénior
    Avatar de Marco46
    Homme Profil pro
    Développeur informatique
    Inscrit en
    Août 2005
    Messages
    4 413
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 42
    Localisation : France, Paris (Île de France)

    Informations professionnelles :
    Activité : Développeur informatique

    Informations forums :
    Inscription : Août 2005
    Messages : 4 413
    Points : 19 609
    Points
    19 609
    Par défaut
    Citation Envoyé par Michael Guilloux Voir le message
    À quelle fréquence pensez-vous utiliser des commentaires ? Rarement, souvent, très souvent ?
    Jamais. Ça a été dur à écrire, ça doit être dur à lire.

    Blague à part, le moins possible, il n'y a rien de pire que du commentaire obsolète induisant en erreur. Les tests automatisés ont bien plus de valeur, il vaut donc mieux écrire un test qu'un commentaire !

    EDIT : Une seule exception, les commentaires de documentation d'API publique.
    Un problème avec Git ? Essayez la FAQ, sinon posez votre question sur le forum.



    "Toute personne croyant qu'une croissance exponentielle peut durer indéfiniment dans un monde fini est soit un fou, soit un économiste."
    Kenneth E. Boulding

    "Les richesses naturelles sont inépuisables, car, sans cela, nous ne les obtiendrions pas gratuitement. Ne pouvant être ni multipliées ni épuisées, elles ne sont pas l’objet des sciences économiques."
    Jean-Baptiste Say, Traité d'économie politique, 1803.

    "/home/earth is 102% full ... please delete anyone you can."
    Inconnu

  4. #144
    Nouveau membre du Club
    Avatar de the_mummy
    Homme Profil pro
    Développeur informatique
    Inscrit en
    Août 2017
    Messages
    12
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : Cameroun

    Informations professionnelles :
    Activité : Développeur informatique
    Secteur : Industrie

    Informations forums :
    Inscription : Août 2017
    Messages : 12
    Points : 26
    Points
    26
    Billets dans le blog
    1
    Par défaut
    Ceci devrait faire l'objet d'une UE dans les formations de développement!!!
    il y a trop de développeur (commentateur) chevronnés dans cet univers

  5. #145
    Membre expert
    Homme Profil pro
    Retraité
    Inscrit en
    Octobre 2005
    Messages
    1 473
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 65
    Localisation : France, Seine Saint Denis (Île de France)

    Informations professionnelles :
    Activité : Retraité
    Secteur : Finance

    Informations forums :
    Inscription : Octobre 2005
    Messages : 1 473
    Points : 3 283
    Points
    3 283
    Par défaut
    Citation Envoyé par el_slapper Voir le message
    ...

    Bon, le COBOL est verbeux et les majuscules ont tendance à faire fuir les petits jeunes, désolé. Et tout ceci marche parcequ'on a soigneusement préparé ses booléens en amont. Le SELECT CASE TRUE est considéré comme une horreur dans d'autres langages, mais en COBOL, ça passe très bien ...
    Petite précision, l'instruction de CHOIX multiple en COBOL n'est pas SELECT CASE mais EVALUATE WHEN ...

  6. #146
    Expert éminent sénior
    Profil pro
    Inscrit en
    Décembre 2007
    Messages
    6 803
    Détails du profil
    Informations personnelles :
    Localisation : France, Hérault (Languedoc Roussillon)

    Informations forums :
    Inscription : Décembre 2007
    Messages : 6 803
    Points : 32 058
    Points
    32 058
    Par défaut
    Citation Envoyé par Luc Orient Voir le message
    Petite précision, l'instruction de CHOIX multiple en COBOL n'est pas SELECT CASE mais EVALUATE WHEN ...
    Exact, mais je parlais à des non cobolistes....(et j'ai beaucoup pratiqué le EVALUATE TRUE, donc)
    Les 4 règles d'airain du développement informatique sont, d'après Michael C. Kasten :
    1)on ne peut pas établir un chiffrage tant qu'on a pas finalisé la conception
    2)on ne peut pas finaliser la conception tant qu'on a pas complètement compris toutes les exigences
    3)le temps de comprendre toutes les exigences, le projet est terminé
    4)le temps de terminer le projet, les exigences ont changé
    Et le serment de non-allégiance :
    Je promets de n’exclure aucune idée sur la base de sa source mais de donner toute la considération nécessaire aux idées de toutes les écoles ou lignes de pensées afin de trouver celle qui est la mieux adaptée à une situation donnée.

  7. #147
    Membre expérimenté
    Profil pro
    chercheur
    Inscrit en
    Avril 2004
    Messages
    830
    Détails du profil
    Informations personnelles :
    Localisation : France, Essonne (Île de France)

    Informations professionnelles :
    Activité : chercheur

    Informations forums :
    Inscription : Avril 2004
    Messages : 830
    Points : 1 453
    Points
    1 453
    Par défaut exemples un peu moins niais
    Il est intéressant de considérer des exemples un peu moins niais.
    Soit
    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    5
    //data[1..d1,1..d2]
    // somme des carrés
    for i:=1 to d1 do
    for j:=1 to d2 do
    somme:=somme+sqr(data[i,j]);
    ou bien

    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    for indice_balayant_la_première_dimension_du_tableau_des_données:=1 to première_dimension_tableau_des_données do
    for indice_balayant_la_deuxième_dimension_du_tableau_des_données:=1 to deuxième_dimension_tableau_des_données do
    somme_des_carrés_des_éléments_du_tableau_des_données:=somme_des_carrés_des_éléments_du_tableau_des_données+sqr(tableau_des_données[indice_balayant_la_première_dimension_du_tableau_des_données,indice_balayant_la_deuxième_dimension_du_tableau_des_données]);
    Ce qui s'énonce clairement se conçoit bien ( Le hautbois)

  8. #148
    Expert confirmé Avatar de psychadelic
    Profil pro
    Inscrit en
    Mai 2010
    Messages
    2 529
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : Mai 2010
    Messages : 2 529
    Points : 4 740
    Points
    4 740
    Par défaut
    Je me suis fait les dents en C en épluchant les bouquins de Scott Knaster.
    J'ai travaillé sur des bibliotheques en C et C++ sur des produits financiers devant réaliser des formules complexes sur des indices complexes avec des variables complexe ou il faut parfois plusieurs heures avant d'en comprendre le sens et le comment du pourquoi.
    Alors quand t'a passé un semaine sur un swap de taux avec des conversions de monnaies fluctuantes, ben ,tes super content de retrouver un gros commentaire qui t'explique ce qu'il ne faut surtout pas tripoter et un rappel des règles qui s'y appliquent, voir même des petits rappels triviaux pour te dire que cette variable joue sur un taux directeur, même si elle s'appelle justement taux_directeur, parce que je ne connais pas un développeur capable de garder la tête froide en jonglant avec 36 formules mathématiques et financières à longueur de journée.

    Et pour en revenir à Scott Knaster, je fais comme lui, je dissémine de l'humour au second degré dans mon code (mais toujours en lien avec l’algorithme, parce que je me suis rendu compte que cela faisait toujours plaisir à ceux devaient re-tripoter le code, et que s'il est placé au bon endroit cela leur permettait de mieux se souvenir des écueils à éviter.

    Les exemples de codes sur le sujet , c'est du flan à coté.
    «La pluralité des voix n'est pas une preuve, pour les vérités malaisées à découvrir, tant il est bien plus vraisemblable qu'un homme seul les ait rencontrées que tout un peuple.» [ René Descartes ] - Discours de la méthode

  9. #149
    Membre du Club
    Profil pro
    Inscrit en
    Juin 2009
    Messages
    19
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : Juin 2009
    Messages : 19
    Points : 46
    Points
    46
    Par défaut
    Citation Envoyé par hotcryx Voir le message
    Les commentaires ça sert à rien, c'est pas compilé (troll off)
    Y a pire : ajouter un checkArgument compilé à la place d'un commentaire rappelant pourquoi on peut s'en passer ... (cf. l'avant dernier exemple ... qui est peut-être situé juste 10 lignes en dessous du checkArgument)

  10. #150
    Membre averti

    Profil pro
    Étudiant
    Inscrit en
    Décembre 2004
    Messages
    499
    Détails du profil
    Informations personnelles :
    Âge : 37
    Localisation : France

    Informations professionnelles :
    Activité : Étudiant

    Informations forums :
    Inscription : Décembre 2004
    Messages : 499
    Points : 422
    Points
    422
    Par défaut
    Il me semble que vous n'avez pas parlé de la distinction énorme entre lire le code et l'exécuter avec un débugger.

    À mon avis utiliser un débugger pour comprendre comment fonctionne un code c'est tout un art, dont bien des aspects restent encore à être développés,

    et qu'en la matière les bonnes pratiques vont beaucoup plus loin que l'idée d'écrire un code propre et localement lisible avec quelques commentaires pertinents.

    Typiquement la facilité à comprendre une méthode dépend énormément des paramètres donnés en entrée. C'est con mais pour comprendre un algorithme sur une liste, donner en entrée la liste vide ça marche moins bien.

  11. #151
    Expert éminent
    Avatar de Matthieu Vergne
    Homme Profil pro
    Consultant IT, chercheur IA indépendant
    Inscrit en
    Novembre 2011
    Messages
    2 264
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : France

    Informations professionnelles :
    Activité : Consultant IT, chercheur IA indépendant
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Novembre 2011
    Messages : 2 264
    Points : 7 760
    Points
    7 760
    Billets dans le blog
    3
    Par défaut
    Un code bien fait a des messages d'erreurs assez clairs pour comprendre ce qui ne va pas. Nécessiter le débogueur (ou des prints supplémentaires) pour comprendre ce qui ne va pas indique avant tout un code qui mériterait d'être amélioré.

    Dit autrement, si "comprendre comment fonctionne un code c'est tout un art", que ce soit avec un débogueur ou un outil plus adapté, c'est que le code n'est pas aisément compréhensible. Or c'est justement l'objet d'une structuration logique du code, d'un nommage clair, de la documentation (messages d'erreurs inclus) et des commentaires (ce dernier étant l'objet du sujet). Si une information est nécessaire à la compréhension, soit elle doit être donnée, soit les informations nécessaires pour l'obtenir doivent être données à la place. Pour le dernier cas, je pense notamment aux informations qui sont techniquement ou légalement indisponibles.

    Même si on peut toujours parler du débogueur pour être plus exhaustif, c'est regarder les conséquences plutôt que les causes, ce n'est donc pas régler le problème de manière définitive.
    Site perso
    Recommandations pour débattre sainement

    Références récurrentes :
    The Cambridge Handbook of Expertise and Expert Performance
    L’Art d’avoir toujours raison (ou ce qu'il faut éviter pour pas que je vous saute à la gorge {^_^})

Discussions similaires

  1. Réponses: 25
    Dernier message: 06/01/2013, 17h22
  2. Faut-il commenter son code source pour le rendre plus lisible et maintenable ?
    Par mayayu dans le forum Débats sur le développement - Le Best Of
    Réponses: 149
    Dernier message: 09/11/2009, 02h30
  3. Bien commenter son code Java
    Par shaun_the_sheep dans le forum Général Java
    Réponses: 2
    Dernier message: 27/05/2008, 11h13
  4. Comment commenter son code source proprement ...
    Par basnifo dans le forum MFC
    Réponses: 3
    Dernier message: 31/03/2006, 16h22

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo