Dois-je signaler les erreurs d’orthographe / grammaire dans le code d’une personne? [fermé]

En examinant le code d'un collègue, je suis tombé sur des erreurs d'orthographe dans les noms de fonctions, ainsi que des erreurs grammaticales telles que 'doesUserHasPermission ()' au lieu de 'doesUserHavePermission ()' dans les noms de fonctions et de variables.

Devrais-je les lui signaler ou suis-je trop pédant en les remarquant?

Un code avec des fautes d'orthographe et de grammaire est impossible à maintenir .

• Les gens ne se souviendront pas de la mauvaise grammaire, alors ils essaieront d'appeler la fonction comme elle aurait dû être écrite, et c'est ainsi que les bugs se produisent.

• Vous ne pouvez pas trouver quelque chose dans le code si vous ne savez pas comment il s'écrit.

• La plupart des gens qui font de la grammaire ou de l'orthographe le font de manière incohérente, ils introduiront donc de nombreux bogues dont le nom ne correspond pas. Ceci est particulièrement problématique dans les langues qui n'exigent pas que les variables soient explicitement déclarées avant leur utilisation, car vous pouvez introduire une nouvelle orthographe et votre code ne s'arrêtera pas de vous dire que vous avez foiré.

La correction de ces problèmes n’est ni pédante ni nécessaire en premier lieu par les opinions des autres sur l’intelligence, l’alphabétisation, etc. (bien que ce soit un effet secondaire important); il s'agit d'écrire un code de qualité, maintenable .

Oui définitivement. Il est plus facile de retenir le nom s'il est correct grammaticalement. Essayer de se rappeler le nom et les fautes de grammaire est une autre chose.

Ne les signalez pas comme des défauts dans une révision de code formelle. Au lieu de cela, annotez une liste et parlez-en PRIVÉ à leur sujet. Soyez aussi diplomate que possible, juste "Hé, quelque chose que j'ai remarqué, et j'ai rencontré des gens qui VRAIMENT méprisent ce genre de chose, ils pensent que cela donne au programmeur une apparence négligente et négligée."

Si c'est le code qu'un client va voir, il DOIT absolument être corrigé. Qu'on le veuille ou non, cela reflète la réputation de votre entreprise.

Pour l'exemple que vous avez donné, je suppose que cela a commencé avec UserHasPermission, et quelqu'un d'autre lui a dit que la pratique locale était doUserBlahBlah () plutôt que UserBlahBlah (), et il a simplement ignoré le changement de grammaire.

Changez-le vous-même.

J'espère que vous êtes dans un environnement où la "propriété" du code n'est pas un problème. Si vous avez accès au projet dans le contrôle de code source, allez simplement le réparer vous-même. Si vous voyez un collègue en particulier commettre le même type de fautes de grammaire ou d'orthographe de manière cohérente, vous voudrez peut-être le souligner, mais cela dépendra de votre relation, du fait qu'il soit ou non anglophone et de sa réceptivité générale. Mais que vous décidiez de le faire ou non, allez-y tranquillement pour remédier à la situation. Je le fais tout le temps, si je vois une faute de frappe, en particulier dans une signature de méthode ou une propriété publique, je la répare simplement. Parfois, je ne peux même pas résister à la tentation de corriger une faute de frappe dans un commentaire, mais ce n'est que moi :)

Je suis un développeur dont la langue maternelle n'est ni l'anglais, ni le néerlandais, et je ne voudrais absolument pas que quelqu'un me signale une faute de grammaire ou d'orthographe. De cette façon, je peux constamment améliorer mon anglais. Et il n’est certainement pas difficile de corriger toutes les erreurs de votre code source. Un simple script Perl peut facilement être écrit pour parcourir tous les fichiers d'un dossier. Peut-être que même cela peut être fait avec sed? Je ne sais pas.

Donc, je signalerais certainement des fautes de grammaire ou d’orthographe dans le code de quelqu'un d’autre, mais seulement si je suis absolument certain que ce que je dis est correct.

Je suppose que cela vaut la peine de mentionner ici que l'en-tête de référent HTTP dans le protocole HTTP était mal orthographié en tant que "référant" (et nous devons vivre avec cela / nous avons appris à vivre avec.) :)

Je suis d'accord avec d'autres réponses en disant que le code avec des fautes de grammaire est intenable.

Je veux aussi ajouter quelques choses:

• Le code est souvent écrit par des personnes qui ne parlent pas très bien l'anglais et / ou l'anglais n'est pas leur langue maternelle. Si vous examinez une erreur de grammaire dans un code, cela ne signifie pas que votre collègue a commis cette erreur. Peut-être que c'était juste un copier-coller d'un site Web.
• Si l'anglais n'est pas la langue maternelle de votre collègue, il peut s'avérer une bonne ou une très mauvaise idée de lui parler de cette erreur. Étant originaire de France, j'apprécie toujours les remarques sur les erreurs que je fais en anglais, car c'est le seul moyen de les éviter à l'avenir. Par contre, je connais plusieurs personnes qui se sentent vraiment blessées si vous leur parlez des erreurs de grammaire qu'elles font.
• Comme John R. Strohm l'a dit, ne le faites jamais publiquement. La plupart des gens seront vraiment ennuyés par cela.

Je recommanderais d'utiliser un IDE avec un correcteur orthographique intégré. IntelliJ Idea fait un travail formidable pour les programmes Java. Il saisit de nombreuses fautes de frappe embarrassantes, non seulement dans les noms de fonctions, mais également dans les messages d'exception que l'utilisateur peut voir. Un programme qui produit des messages pleins de fautes de frappe n’inspire pas beaucoup de confiance.

Je le fais seulement si

• cela affecte l'utilisation du programme
• cela affecte la précision du programme
• Je sais explicitement que l'auteur veut être corrigé.

En passant, si les noms de vos fonctions sont suffisamment longs pour avoir une grammaire, ils sont probablement trop longs. Dans l'exemple donné, j'appellerais la fonction userHasPermission et déplacerais la "grammaire" dans votre code, à peu près comme ceci:

if userHasPermission() ...

Cela arrive aussi BEAUCOUP dans mon projet (peuplé par des personnes parlant hébreu, russe ou arabe), mais même à un niveau supérieur - je vois souvent du code qui utilise une terminologie obscure qui se trouve être ce que le dictionnaire a produit comme traduction ce à quoi l'auteur pensait et cela n'a rien à voir avec ce qu'ils voulaient dire ...

Personnellement, quand cela arrive si souvent et par tant de membres de l'équipe qui auraient pu écrire le code avant même que je rejoigne le projet, j'ai tendance à l'ignorer, parce que ce n'est pas grave.

Cependant, si je commets des travaux dans le même fichier que du code ou des commentaires qui ont été écrits il y a longtemps et qu'ils contiennent des fautes de frappe, je les corrigerai simplement parce que ce n'est pas trop de travail.

La règle d'or s'applique

Faites aux autres ce que vous voudriez qu'ils vous fassent.

Je veux que les autres sachent ce genre de chose, alors j’aide les autres. Être aimable et solidaire peut vous être très utile.

Comme pour beaucoup d'autres bonnes pratiques de programmation, le seul moyen objectif, apolitique et efficace de mettre en œuvre une politique sur l'orthographe dans les programmes est de l'automatiser dans le cadre du processus de pré-validation. L'automatisation vous épargnera d'énormes quantités de griefs même si vous devez écrire votre propre outil à cet effet.

C'est une erreur mineure dans le code, mais c'est une erreur. Traitez-le comme n'importe quelle autre erreur que vous trouvez. Ma politique est toujours de supposer que mes collègues sont compétents et de les traiter de cette manière jusqu'à preuve du contraire.

Si c'est une simple erreur, je pourrais peut-être simplement corriger le problème et l'enregistrer. Si c'est un schéma habituel, je pourrais demander à ce collègue de passer en revue ces correctifs. Dites-leur que vous pensez qu'ils sont un bon codeur, mais que c'est quelque chose qu'il serait bon d'améliorer. Je ne pense pas que je ferais jamais un gros problème avec quelque chose comme ça cependant.

Tant que vous ne le traitez pas comme un gros problème, il devrait être facile de mettre ce collègue dans une position où il peut s’améliorer sans mettre son ego en danger.

userPermission () peut-être? -

Le dernier problème que j'ai rencontré concernait un problème général: les résultats de la recherche n'étaient pas mis en évidence car le nom de la classe était orthographié hightlight. Bug très obscur à repérer.

Indiquez-le bien, mais ne perdez pas votre temps à vérifier les fautes d'orthographe. Utilisez un outil pour automatiser cela sur votre CI. Sur .net, fxCop peut le faire ...

Tout dépend en grande partie de la nature des erreurs, de leur fréquence et de leur gravité, et de la question de savoir s’il s’agit d’une erreur réelle ou de la façon dont vous la formulez.

Personnellement, je ne peux pas supporter ça quand un idiot traîne une révision de code en 5 minutes en une demi-heure parce qu'il veut que tout soit renommé comme il le ferait et que tous les commentaires soient reformulés juste parce qu'il aime y mettre la main. il n'est pas nécessaire de remplacer "Chargement des objets de données" par "Le composant chargeur d'objet de données va maintenant charger les objets de données appropriés à partir du composant de stockage d'objet de données".

/ rant :)