Traitement des normes de codage au travail (je ne suis pas le patron)

Je travaille sur une petite équipe, environ 10 développeurs. Nous n'avons aucune norme de codage. Certaines choses sont devenues la norme, mais certaines façons de faire sont complètement disparates. Mon plus gros problème est l'indentation. Certains utilisent des tabulations, d'autres des espaces, d'autres utilisent un nombre différent d'espaces, ce qui crée un énorme problème. Lorsque je fusionne, je suis souvent confronté à des conflits parce que quelqu'un utilisait son IDE pour se formater automatiquement et utilisait un caractère différent du mien pour l'indentation. Je me fiche de savoir qui nous utilisons, je veux juste que nous utilisions tous le même.

Ou bien je vais ouvrir un fichier et certaines lignes ont des accolades sur la même ligne que la condition alors que d'autres les ont sur la ligne suivante. Encore une fois, je ne me soucie pas de savoir lequel, pourvu qu'ils soient tous identiques.

J'ai abordé la question des normes avec mon supérieur hiérarchique direct, individuellement et lors de réunions de groupe, et il ne s'en préoccupe pas excessivement (plusieurs autres partagent le même point de vue que moi). J'ai évoqué ma préoccupation spécifique concernant les caractères d'indentation et il a pensé qu'une meilleure solution consisterait à "créer une sorte de script capable de convertir tout cela lorsque nous poussons / retirons du repo". Je soupçonne qu'il ne veut pas changer et que cette solution semble trop compliquée et sujette à des problèmes de maintenance à l'avenir (cela ne concerne également qu'une manifestation d'un problème plus vaste).

L'un de vous a-t-il rencontré une situation similaire au travail? Si oui, comment l'avez-vous géré? Quels seraient les bons points pour aider à vendre mon patron sur des normes? Lancer un mouvement populaire pour créer des normes de codage, parmi ceux d’entre nous qui sommes intéressés, serait une bonne idée? Suis-je trop particulier, devrais-je le laisser aller?

Merci à tous pour votre temps.

Remarque: Merci à tous pour les bons commentaires reçus jusqu'à présent! Pour être clair, je ne veux pas dicter Un style pour les gouverner tous. Je suis prêt à concéder ma manière préférée de faire quelque chose en faveur de ce qui convient le mieux à tout le monde. Je veux de la cohérence et je veux que cela soit une démocratie. Je veux que ce soit une décision de groupe sur laquelle tout le monde s’accorde. Certes, tout le monde ne réussira pas, mais j'espère que tout le monde sera suffisamment mûr pour faire des compromis en vue de l'amélioration du groupe.

Note 2: Certaines personnes sont prises dans les deux exemples que j'ai donnés ci-dessus. Je suis plus après le coeur de la matière. Il se manifeste par de nombreux exemples: conventions de dénomination, fonctions énormes qui doivent être décomposées, si quelque chose devait arriver dans un util ou service, si quelque chose devait être constant ou injecté, si nous utilisions tous des versions différentes d’une dépendance ou du même, si interface soit utilisé dans ce cas, comment les tests unitaires doivent-ils être configurés, ce qui doit être testé, (spécifique à Java) doit-on utiliser des annotations ou une configuration externe? Je pourrais continuer.

Un collègue de travail et moi avons eu un problème similaire au sein de notre équipe lorsque nous nous sommes joints pour la première fois (j'ai d'abord rejoint l'équipe, il l'a rejoint environ un an plus tard). Il n'y avait pas de véritables normes de code. Nous sommes un magasin MS et même les normes de codage MS n'ont pas été utilisées. Nous avons décidé de donner l'exemple. Nous nous sommes assis ensemble et avons rédigé un document contenant toutes nos normes: normes IDE, normes de nommage, tout ce à quoi nous pouvions penser. Ensuite, lui et moi avons accepté de suivre la norme de manière explicite. J'ai envoyé un courrier électronique à l'équipe (de nous deux), et les ai informés que nous avions trouvé un manque et que nous allions le corriger avec notre document. Nous avons invité des critiques, des idées, des commentaires, des opinions. Nous avons reçu très peu de commentaires et n’avons que peu de répulsion. Lui et moi avons immédiatement commencé à utiliser les normes, et lorsque nous avons invité des développeurs débutants dans nos projets, nous leur avons présenté la norme et ils ont commencé à l'utiliser. Nous avons quelques pistes qui étaient réticentes au début mais qui ont lentement commencé à utiliser le standard pour de très nombreuses choses.

Nous avons constaté que de nombreux développeurs débutants avaient reconnu le même problème mais attendaient que quelqu'un d'autre prenne la décision. Une fois qu’il y avait un plan à suivre, beaucoup étaient impatients de l’adopter. Ce qui est difficile à casser, ce sont ceux qui refusent de coder par tout autre moyen, et ils se codent généralement eux-mêmes à la longue.

Si vous voulez des standards, tracez le chemin. Dressez une liste de normes suggérées qui, selon vous, bénéficieraient à votre équipe. Soumettez-le à des pairs et des pistes de commentaires. Je suis sûr que d'autres membres de votre équipe ont des idées similaires, mais ils n'ont probablement pas le courage de faire quoi que ce soit à ce sujet. Comme Gandhi l'a dit: "Vous devez être le changement que vous souhaitez voir dans le monde."

Les normes ne doivent pas être définies et appliquées par un responsable. L’équipe dans son ensemble devrait accepter les normes. S'ils n'arrivent pas à s'entendre sur un ensemble de normes communes, le fait de leur imposer des normes échouera.

Vous et les autres qui êtes d'accord avec vous devriez donner l'exemple. Commencez à utiliser les mêmes normes de codage, publiez-les, faites-en la promotion auprès du reste de l'équipe et demandez-leur de vous donner leur avis sur la façon de les améliorer.

Voici l'essentiel lorsque vous essayez de promouvoir les normes: assurez-vous que l'objectif n'est pas de trouver la meilleure façon de faire les choses, mais plutôt de trouver une manière cohérente de faire les choses. Bien que certaines personnes puissent ne pas être d’accord, il n’existe pas de style unique, de style de commentaire, etc. Ce qui rend le code plus facile à lire (et donc plus facile à gérer) est un style cohérent, quel qu’il soit.

Pouvez-vous montrer quelques preuves du temps que vous avez perdu à cause des problèmes que cela cause?

Si vous passez beaucoup de temps à résoudre ces problèmes ou que vous créez des bogues qui prennent du temps à corriger, il est possible de réduire considérablement ce coût en adoptant des normes de codage.

Alors, gardez un journal des problèmes que vous rencontrez et du temps qu'il faut pour les résoudre - à la fois pour vous et (lorsque vous en avez connaissance) avec vos collègues.

Ensuite, lorsque vous avez une quantité raisonnable de données, présentez-les à vos collègues. Ils devraient voir l'avantage d'adopter une norme. Si ce n'est pas le cas, montrez les données à votre chef et à son chef. Montrez qu'en établissant des normes de codage, vous pouvez économiser de l'argent à votre entreprise et elle devrait vous aider à les faire adopter.

Sur votre situation particulière, je pense que la solution de votre patron est une bonne solution. Personne ne doit changer ce qu’il a fait pendant toute sa carrière, et c’est normal parce que le style de code ignoré par le compilateur n’a aucune importance tant que le code est lisible. Si tout le monde modifiait automatiquement son style lors de la vérification et formait automatiquement un style standard lors de l'enregistrement, tout irait bien. (Malheureusement, j’ai suggéré que c’est là où je travaille que les choses se sont opposées, au motif que le codeur n’écrirait plus le même code exact que le serveur d’intégration continue voit.)

Je pense que les normes de codage sont bonnes lorsqu'elles sont appliquées à des endroits où la qualité du code est réellement différente: par exemple, méthodes réduites, classes ayant une responsabilité clairement définie, commentaires utiles et précis pour les bits les plus difficiles, etc. Malheureusement, ces aspects sont plus difficiles à vérifier automatiquement, mais c’est fondamental pour le développement logiciel. Tout ce que vous pouvez réellement faire, c'est enseigner aux autres de bonnes pratiques et à vous-même à lire le code avec le support sur la mauvaise ligne.

En ce qui concerne les normes de codage: je vais me joindre à presque tout le monde pour dire que les normes de codage sont une "bonne chose" (par rapport à l'absence de normes).

Cependant, ne vous laissez pas emporter. J'ai travaillé sur des projets qui dictaient un style d'indentation spécifique, jusqu'au nombre de caractères (et quand les projets vont aussi loin, ils choisissent inévitablement quelque chose de stupide comme l'indentation de 8 espaces). Ne pas transpirer les petites choses.

Une solution simple: donnez aux développeurs un choix limité d'options d'accolade et d'indentation, mais indiquez que le style d'accolade et l'indentation doivent être cohérents dans l'ensemble du module. (Vous voulez que foo.h et foo.cpp suivent le même style, n'est-ce pas?) Les mainteneurs doivent s'adapter au style existant; ils ne peuvent pas réécrire un module en fonction de leur style fantaisiste. Plusieurs styles dans un module sont source de confusion et sont un signe de négligence. Quand je vois ce non-sens, je me demande ce qui ne va pas.

Vous pouvez également envisager d’interdire les tabulations d’indentation dans le contenu enregistré d’un fichier . La plupart des IDE / éditeurs font un travail raisonnable en traduisant des onglets de saisie utilisateur en espaces, et la plupart ont des options pour rendre cette traduction automatique. Beaucoup font un travail de merde quand le fichier contient déjà des onglets, en particulier un sac mélangé d'onglets et d'espaces.

Cela dit, je pense que votre projet pose peut-être un problème plus grave. Vous avez mentionné des problèmes de fusion. Si vous avez besoin de beaucoup fusionner, cela peut indiquer un mauvais partitionnement du projet. Tout comme trop de cuisiniers gâchent le bouillon, trop de programmeurs opérant sur le même fichier gâchent le projet. Pourquoi Joe, Susie et vous touchez-vous à foo.cpp?

C'est l'un des domaines dans lesquels des recherches sont effectuées. Fondamentalement, la question principale est de savoir si vous faites des révisions de code. Les revues de code sont sans aucun doute le moyen le plus efficace d’améliorer la qualité du code. (Source: Institut de génie logiciel, CMU). C'est certainement plus efficace qu'un testeur supplémentaire.

Désormais, les critiques de code bénéficient d'une norme de codage commune, car cela facilite la lecture du code des autres peuples. Cela vous fournit un argument en deux étapes pour introduire des normes de codage: en fin de compte, il est moins coûteux de produire un bon code.

Puisqu'il y a déjà "plusieurs autres" qui sont avec vous à ce sujet, je suggérerais une réunion impromptue. Inviter tous les devs, prendre un peu de temps et de comprendre ce que les choses sont vous dérangent et vos collègues au jour le jour. N'essayez pas de trouver des solutions spécifiques au début, mais déterminez simplement ce qui doit changer dans la manière dont vous écrivez tous le code à l'heure actuelle.

Ensuite, voyez si vous pouvez tous vous mettre d’accord sur certains concepts de base. La suggestion d'utiliser le même style dans chaque module évoqué par @David Hammen est un bon début, et je pense que la plupart des développeurs pourraient facilement accepter.

Si, une fois que vous avez compris, vous sentez que vous pouvez être d’accord sur un style de base pour écrire du nouveau code, c’est un bon ajout. Concentrez-vous sur des choses qui ont réellement un impact sur la maintenabilité; Les problèmes de nommage seraient en haut de ma liste personnelle, car si vous avez une demi-douzaine de styles de nommage différents dans un même produit d'une complexité notable, cela va vite devenir un casse-tête, mais encore une fois, concentrez-vous sur ce que vous estimez important pour vous et votre équipe . Rédigez un court document que tout le monde peut au moins accepter de suivre (même s'ils ont eux-mêmes un style de familier différent) et envoyez-le à tous les membres de l'équipe. Faites-en un document "vivant", assurez-vous de le mettre à jour avec le temps, mais veillez à ne pas le rendre trop rigide et spécifique.

À moins que votre patron ne soit impliqué dans la rédaction de code, il ne devrait pas trop se soucier du style exact adopté (à condition qu'il soit axé sur la lisibilité et la maintenabilité), mais il devrait être en mesure de voir les avantages de tous les membres de l'équipe suivant un style commun. lors de l'écriture du code.

Certaines choses sont douloureuses. Le plus pénible est un IDE qui reformate automatiquement le code, associé à des développeurs qui configurent leurs IDE de différentes manières. Chaque fois que vous comparez le code, vous avez des centaines de modifications après que quelqu'un avec des paramètres différents a modifié le code. C'est inacceptable. Ici, vous devez rassembler tous les esprits, vous mettre d’accord sur un ensemble de paramètres et rejeter toute vérification effectuée par quiconque utilisant des paramètres différents. Si je modifie une seule ligne de code, les diffs devraient afficher une seule ligne de code modifiée, et non des centaines.

Tout le reste est soit inoffensif, soit il existe de meilleures façons de faire des choses dont d'autres peuvent être convaincus. Ici, la règle devrait être la suivante: ne jouez pas avec le code des autres personnes si vous ne l'améliorez pas vraiment. Et un mélange de style A et de style B est toujours pire que le style A ou le style B.

Assurez-vous de suivre les meilleures pratiques. Ce qui est différent par langue. Mais là, vous n’avez pas besoin de normes (qui ont peut-être été écrites par une personne bien intentionnée mais pas réellement informée), mais tout le monde devrait essayer de donner de bons exemples.

Évitez certainement les luttes de pouvoir. Il n'y a rien de pire qu'un petit Hitler de votre équipe qui tente de forcer tout le monde à faire ce qu'il veut. Et c'est malheureusement le type qui se portera volontaire pour rédiger vos normes de codage :-(

Tous les exemples que vous avez donnés concernent essentiellement les espaces et le formatage. Si c'est le plus gros problème, je suis plutôt d'accord avec votre responsable: ce n'est pas un gros problème.

Là où les normes sont vraiment très utiles, il faut nommer et réduire la complexité. Comment nommer des identificateurs, des classes, où les placer, etc. Il est extrêmement important de conserver des noms cohérents, en particulier dans un projet de grande taille. Les règles permettant de réduire la complexité incluent de conserver les fonctions sous un certain nombre de lignes (les diviser en fonctions plus petites) ou de conserver les listes de paramètres sous un certain nombre d'arguments (peut-être devriez-vous les regrouper dans un objet et les transmettre).

Si un développeur spécifique de votre équipe écrit un code plus difficile à comprendre / à déboguer, car il comprend de nombreux morceaux de code longs avec des noms de variable à une lettre, c’est une bonne raison d’adopter certaines normes, et non quelque chose qui puisse être corrigé. un script. C’est une bonne chose de souligner (avec tact) que les normes peuvent être améliorées.

Une autre raison pour laquelle votre responsable n’a peut-être pas considéré cela comme un problème est que vous ne lisez pas très souvent le code de chacun. Cela peut arriver lorsque tout le monde a son propre domaine du code et ne s'aventure pas trop en dehors de celui-ci. Cela fonctionne plutôt bien jusqu'à ce que quelqu'un quitte l'organisation, ce qui peut arriver pour diverses raisons, bonnes ou mauvaises. Les normes qui améliorent la lisibilité faciliteront la tâche à un nouveau développeur de prendre en charge la maintenance d’un morceau de code.

conflits lorsque je fusionne parce que quelqu'un utilise son IDE pour le formatage automatique et utilise un caractère différent pour indenter le mien

Cela semble être votre problème, pas le formatage, mais le reformatage. C'est un problème énorme pour les SMC et le conseil est simple: ne le faites pas. Ainsi, la prochaine fois que quelqu'un reformatera tous les espaces en onglets ou modifiera les accolades à leur style préféré, vous devrez les gifler. Faites-les fusionner à la place; tenez-vous à leur côté, désapprouvant la perte de temps que leur négligence a causée

L'alternative est de mettre un formateur de pré-validation dans, qui re-formate toujours tout le code dans le style standard avant l'archivage. Si vous avez une équipe de développeurs qui reformate naturellement, c'est une bonne option - le SCM verra toujours le même format, donc les deltas seront petits et agréables à fusionner.

Lorsque quelqu'un propose une nouvelle norme de codage dans laquelle je travaille, nous la votons. S'il obtient un vote à la majorité, il est accepté, sinon il est rejeté. Si vous ne le faites pas, vous n'accepterez pas vos normes et elles ne seront pas utilisées même si elles sont documentées.

En ce qui concerne votre question spécifique, votre meilleur pari commencera probablement par la suggestion de Joel et donnera l'exemple. Rassemblez 1 ou 2 programmeurs qui s’intéressent à ce sujet, concluez un accord et vous aurez le pouvoir d’imposer ceux qui sont paresseux.

Maintenant, pour le problème générique, je trouve préférable de simplement moduler . Chaque personne reçoit un fichier différent. Si vous devez gérer un fichier, vous conservez ses normes de codage intactes, même si elles sont différentes les unes des autres. Besoin d'écrire dans le même fichier? Créez un fichier de sous-ensemble et incluez-le à la place.

N'essaye pas ça!

Exemple par exemple. Essayez de rendre votre format de code aussi horrible que possible et enregistrez de nombreux changements horriblement formatés dans le joli code des autres peuples. Lorsque la réaction (inévitable) se produit, dites que ce que vous faites est bien, car il n’existe pas de norme de codage.

Si vos collègues ne vous lynchent pas (!!), vous pouvez vous retrouver avec une norme de codage.

De toute évidence, il s'agit d'une stratégie à haut risque ... :-)