it-swarm-eu.dev

Sollte ich auf Rechtschreib- / Grammatikfehler im Code einer Person hinweisen?

Beim Überprüfen des Codes eines Kollegen stieß ich auf Rechtschreibfehler in Funktionsnamen und auch auf Grammatikfehler wie doesUserHasPermission() anstelle von doesUserHavePermission() in Funktions- und Variablennamen.

Soll ich ihn darauf hinweisen oder bin ich zu pedantisch, wenn ich diese bemerke?

109
Rahul

Code mit Rechtschreib- und Grammatikfehlern ist nicht wartbar .

  • Die Leute werden sich nicht an die schlechte Grammatik erinnern, also werden sie versuchen, die Funktion so aufzurufen, wie sie hätte geschrieben werden sollen, und so passieren Fehler.

  • Sie können nicht nach etwas im Code suchen, wenn Sie nicht wissen, wie es geschrieben ist.

  • Die meisten Personen, die Grammatik/Schreibweisen erstellen, tun dies inkonsistent, sodass sie viele Fehler mit nicht übereinstimmenden Namen einführen. Dies ist besonders problematisch in Sprachen, in denen Variablen vor der Verwendung nicht explizit deklariert werden müssen, da Sie eine neue Schreibweise einführen können und Ihr Code nicht zum Stillstand kommt, um Sie wissen zu lassen, dass Sie es vermasselt haben.

Die Korrektur dieser Probleme ist weder pedantisch noch wird sie in erster Linie durch die Meinung anderer über die eigene Intelligenz, Alphabetisierung usw. erforderlich (obwohl dies ein großer Nebeneffekt ist). Es geht darum zu schreiben Qualität, wartbarer Code.

210
HedgeMage

Ja auf jeden Fall. Es ist einfacher, sich den Namen zu merken, wenn er grammatikalisch korrekt ist. Der Versuch, sich an den Namen nd Grammatikfehler zu erinnern, ist eine ganz andere Sache.

39
Jason Baker

Zeigen Sie sie nicht als Mängel in einer formalen Codeüberprüfung auf. Markieren Sie stattdessen eine Liste und sprechen Sie mit ihm/ihr PRIVAT darüber. Seien Sie so diplomatisch wie möglich, nur "Hey, etwas, das mir aufgefallen ist, und ich habe Leute getroffen, die WIRKLICH auf so etwas herabblicken. Sie denken, es lässt den Programmierer nachlässig und schlampig aussehen."

Wenn dies ein Code ist, den ein Kunde sehen wird, MUSS er unbedingt korrigiert werden. Ob es Ihnen gefällt oder nicht, es spiegelt den Ruf Ihres Unternehmens wider.

Für das Beispiel, das Sie gegeben haben, habe ich den Verdacht, dass es als UserHasPermission begann, und jemand anderes sagte ihm, dass die lokale Praxis DoUserBlahBlah () und nicht UserBlahBlah () ist, und er hat die Grammatikänderung einfach übersehen.

28
John R. Strohm

Ändere es selbst.

Hoffentlich befinden Sie sich in einer Umgebung, in der Code "Besitz" kein Problem darstellt. Wenn Sie in der Quellcodeverwaltung Zugriff auf das Projekt haben, gehen Sie einfach hinein und reparieren Sie es selbst. Wenn Sie sehen, dass ein bestimmter Mitarbeiter die gleiche Art von Grammatik- oder Rechtschreibfehlern konsistent macht, möchten Sie möglicherweise darauf hinweisen. Dies hängt jedoch von Ihrer Beziehung ab, ob die Person Englisch als Muttersprache spricht, und von ihrer allgemeinen Aufnahmefähigkeit. Aber ob Sie sich jemals dafür entscheiden oder nicht, gehen Sie einfach ruhig und machen Sie die Lösung. Ich mache das die ganze Zeit, wenn ich einen Tippfehler sehe, insbesondere in einer Methodensignatur oder einem öffentlichen Eigentum, behebe ich ihn einfach. Gelegentlich kann ich der Versuchung nicht widerstehen, einen Tippfehler in einem Kommentar zu korrigieren, aber das bin nur ich :)

10
Marcie

Ich denke, es ist erwähnenswert, dass der HTTP-Referrer-Header im HTTP-Protokoll als "Referer" falsch geschrieben wurde (und wir müssen damit leben/wir haben gelernt, damit zu leben.) :)

6
Bunny Rabbit

Ich bin ein Entwickler, dessen Muttersprache nicht Englisch ist, sondern Niederländisch, und es würde mir nichts ausmachen, wenn mich jemand auf einen Grammatik- oder Rechtschreibfehler hinweisen würde. Auf diese Weise kann ich mein Englisch ständig verbessern. Und es ist sicherlich nicht schwierig, alle Fehler in Ihrem gesamten Quellcode zu korrigieren. Ein einfaches Perl-Skript kann einfach geschrieben werden, um alle Dateien in einem Ordner zu durchlaufen. Vielleicht kann es sogar mit sed gemacht werden? Ich weiß es nicht.

Ich würde also sicherlich auf Grammatik- oder Rechtschreibfehler im Code eines anderen hinweisen, aber nur, wenn ich absolut sicher bin, ob es richtig ist, was ich sage.

6
user11317

Ich stimme anderen Antworten zu, wonach Code mit Grammatikfehlern nicht zu pflegen ist.

Ich möchte auch ein paar Dinge hinzufügen:

  • Code wird oft von Leuten geschrieben, die nicht sehr gut Englisch sprechen und/oder Englisch ist nicht ihre Muttersprache. Wenn ein von Ihnen überprüfter Code einen Grammatikfehler enthält, bedeutet dies nicht, dass Ihr Mitarbeiter diesen Fehler gemacht hat. Vielleicht war es nur ein Copy-Paste von einer Website.
  • Wenn Englisch keine Muttersprache Ihres Mitarbeiters ist, kann es eine gute oder sehr schlechte Idee sein, ihm/ihr von diesem Fehler zu erzählen. Da ich aus Frankreich komme, freue ich mich immer über Bemerkungen zu den Fehlern, die ich auf Englisch mache, weil ich sie nur so in Zukunft vermeiden kann. Andererseits kenne ich einige Leute, die sich wirklich verletzt fühlen, wenn Sie ihnen von Grammatikfehlern erzählen, die sie machen.
  • Wie John R. Strohm sagte, mach es niemals öffentlich. Die meisten Leute werden sich darüber wirklich ärgern.
4

Ich würde empfehlen, eine IDE mit integrierter Rechtschreibprüfung) zu verwenden. IntelliJ Idea leistet hervorragende Arbeit für Java Programme. Es gibt viele peinliche Tippfehler, die es nicht nur abfängt in Namen von Funktionen, aber zB in Ausnahmemeldungen, die der Benutzer sehen kann. Ein Programm, das Nachrichten voller Tippfehler erzeugt, schafft nicht viel Vertrauen.

2
Roman Zenka

Dies ist ein kleiner Fehler im Code, aber ein Fehler. Behandle es wie jeden anderen Fehler, den du findest. Meine Politik ist immer anzunehmen, dass meine Mitarbeiter kompetent sind und sie so behandeln, bis sie das Gegenteil beweisen.

Wenn es sich um einen einzelnen Fehler handelt, kann ich ihn möglicherweise beheben und einchecken. Wenn es sich um ein Muster handelt, kann ich diesen Mitarbeiter dazu bringen, diese Korrekturen zu überprüfen. Lassen Sie sie wissen, dass Sie denken, dass sie ein guter Programmierer sind, aber dass dies etwas ist, das gut wäre, um es zu verbessern. Ich glaube nicht, dass ich jemals eine große Sache mit so etwas machen würde.

Solange Sie es nicht so behandeln, als wäre es ein großes Problem, sollte es einfach sein, diesen Mitarbeiter in eine Position zu bringen, in der er sich verbessern kann, ohne das Ego aufs Spiel zu setzen.

0
overstood

Es gilt die goldene Regel

Tu anderen, wie du es dir von ihnen tun lassen würdest.

Ich möchte, dass andere solchen Dingen den Rücken kehren, also helfe ich anderen. Freundlichkeit und Unterstützung können einen großen Beitrag zu Ihren Gunsten leisten.

0
kevpie

Wie bei vielen anderen guten Programmierpraktiken besteht die einzige objektive, unpolitische und effektive Möglichkeit, eine Rechtschreibrichtlinie in Programmen umzusetzen, darin, sie im Rahmen des Pre-Commit-Prozesses zu automatisieren. Die Automatisierung erspart Ihnen enorme Beschwerden, selbst wenn Sie Ihr eigenes Tool für diesen Zweck schreiben müssen.

0
Apalala

Ich mache es nur wenn

  • dies wirkt sich auf die Verwendung des Programms aus
  • dies wirkt sich auf die Genauigkeit des Programms aus
  • Ich weiß ausdrücklich, dass der Autor korrigiert werden möchte.

Nur als Randnotiz: Wenn Ihre Funktionsnamen lang genug sind, um Grammatik zu haben, sind sie wahrscheinlich zu lang. In dem angegebenen Beispiel würde ich die Funktion serHasPermission aufrufen und die "Grammatik" in Ihren Code verschieben, ungefähr so:

if userHasPermission() ...
0
Mark Harrison

Dies passiert auch VIEL in meinem Projekt (das von nativ hebräisch, russisch oder arabisch sprechenden Personen bevölkert wird), aber sogar auf einer höheren Ebene - oft sehe ich Code, der eine obskure Terminologie verwendet, für die das Wörterbuch als Übersetzung erstellt wurde was der Autor vorhatte, und es hat nichts mit dem zu tun, was sie meinten ...

Persönlich, wenn es so häufig vorkommt und von so vielen Teammitgliedern, die den Code hätten schreiben können, bevor ich dem Projekt beigetreten bin, neige ich dazu, ihn zu ignorieren, weil es einfach keine Rolle spielt.

Wenn ich jedoch einige Arbeiten in derselben Datei wie Code oder Kommentare erledige, die vor langer Zeit geschrieben wurden und Tippfehler enthalten, werde ich sie korrigieren, nur weil es nicht zu viel Arbeit ist.

0