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

Beim Überprüfen des Codes eines Mitarbeiters stieß ich auf einige Rechtschreibfehler in Funktionsnamen sowie auf grammatikalische Fehler wie "doesUserHasPermission ()" anstelle von "doesUserHavePermission ()" in Funktions- und Variablennamen.

Sollte ich ihn darauf hinweisen, oder bin ich zu pedantisch, wenn ich das bemerke?

Code mit Rechtschreib- und Grammatikfehlern ist nicht zu pflegen .

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

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

• Die meisten Leute, die Grammatik / Rechtschreibung machen, tun dies inkonsistent, so dass sie viele Bugs 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 Erliegen kommt, um Sie über einen Fehler zu informieren.

Das Korrigieren dieser Probleme ist weder umständlich, noch wird es in erster Linie durch die Meinungen anderer über die eigene Intelligenz, Alphabetisierung usw. erforderlich (obwohl dies ein großer Nebeneffekt ist). Es geht um das Schreiben von qualitativ hochwertigem, wartbarem Code .

Ja definitiv. Es ist einfacher, sich den Namen zu merken, wenn er grammatikalisch korrekt ist. Der Versuch, sich an den Namen und die Grammatikfehler zu erinnern, ist eine andere Sache.

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

Wenn dies der 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.

Ich vermute, dass das Beispiel, das Sie angegeben haben, als UserHasPermission begann. Jemand sagte ihm, die lokale Praxis sei doesUserBlahBlah () und nicht UserBlahBlah (), und er übersah nur die Grammatikänderung.

Ä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, müssen Sie es nur selbst reparieren. Wenn Sie sehen, dass ein bestimmter Mitarbeiter dieselbe Art von Grammatik- oder Rechtschreibfehlern konsistent macht, möchten Sie ihn möglicherweise darauf hinweisen. Dies hängt jedoch von Ihrer Beziehung ab, davon, 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 einer öffentlichen Eigenschaft, dann repariere ich es einfach. Gelegentlich kann ich der Versuchung nicht widerstehen, einen Tippfehler in einem Kommentar zu beheben, aber das bin nur ich :)

Ich bin ein Entwickler, dessen Muttersprache nicht Englisch ist, sondern Niederländisch, und es würde mir nichts ausmachen, wenn jemand mir eine Grammatik oder einen Rechtschreibfehler vorschlägt. 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 geht das sogar mit sed? Ich weiß es nicht.

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

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

Ich stimme anderen Antworten zu, die besagen, dass Code mit Grammatikfehlern nicht zu halten 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 Code, den Sie überprüfen, 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 nicht die Muttersprache Ihres Mitarbeiters ist, kann es eine gute oder eine sehr schlechte Idee sein, ihm / ihr von diesem Fehler zu erzählen. Da ich aus Frankreich stamme, freue ich mich immer über Anmerkungen zu den Fehlern, die ich auf Englisch mache, denn nur so kann ich sie in Zukunft vermeiden. Auf der anderen Seite kenne ich einige Leute, die sich wirklich verletzt fühlen, wenn man ihnen von Grammatikfehlern erzählt, die sie machen.
• Wie John R. Strohm sagte, mach es niemals öffentlich. Die meisten Leute werden sich wirklich darüber ärgern.

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, nicht nur bei Funktionsnamen, sondern auch bei Ausnahmemeldungen, die der Benutzer sieht. Ein Programm, das Nachrichten voller Tippfehler erzeugt, weckt nicht viel Vertrauen.

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 gegebenen Beispiel würde ich die Funktion userHasPermission aufrufen und die "Grammatik" in Ihren Code verschieben, ungefähr so:

if userHasPermission() ...

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

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

Wenn ich jedoch eine Arbeit in der gleichen Datei wie Code oder Kommentare, die vor langer Zeit geschrieben wurden, festlege und Tippfehler in der Datei haben, korrigiere ich sie, nur weil es nicht zu viel Arbeit ist.

Goldene Regel gilt

Tun Sie anderen gegenüber so, wie Sie es möchten.

Ich möchte, dass andere dieser Sache den Rücken kehren, also helfe ich anderen. Gnädig und unterstützend zu sein, kann einen großen Beitrag zu Ihren Gunsten leisten.

Wie bei vielen anderen guten Programmierpraktiken besteht die einzige objektive, unpolitische und wirksame Möglichkeit, eine Richtlinie zur Rechtschreibung in Programmen umzusetzen, darin, sie im Rahmen des Pre-Commit-Prozesses zu automatisieren. Die Automatisierung erspart Ihnen enorme Probleme, selbst wenn Sie zu diesem Zweck Ihr eigenes Werkzeug schreiben müssen.

Dies ist ein kleiner Fehler im Code, aber ein Fehler. Behandle es wie jeden anderen Fehler, den du findest. Ich gehe immer davon aus, dass meine Mitarbeiter kompetent sind, und behandle sie so, bis sie das Gegenteil beweisen.

Wenn es sich um einen einzelnen Fehler handelt, kann ich ihn einfach beheben und einchecken. Wenn es sich um ein Muster handelt, kann ich den Kollegen veranlassen, diese Korrekturen zu überprüfen. Lassen Sie sie wissen, dass Sie denken, dass sie ein guter Programmierer sind, aber dass dies etwas wäre, das verbessert werden könnte. Ich glaube nicht, dass ich jemals eine große Sache mit so etwas machen würde.

Solange Sie es nicht wie ein großes Problem behandeln, sollte es einfach sein, diesen Mitarbeiter in eine Position zu bringen, in der er sich verbessern kann, ohne das Ego in Frage zu stellen.

userPermission () vielleicht? -

Das letzte Problem, auf das ich gestoßen bin, war ein globales Problem, bei dem Suchergebnisse nicht hervorgehoben wurden, da der Klassenname als Hervorhebung geschrieben wurde. Sehr dunkler Bug zu erkennen.

Sicher, machen Sie darauf aufmerksam, aber verschwenden Sie keine Zeit damit, nach Rechtschreibfehlern zu suchen. Verwenden Sie ein Tool, um dies auf Ihrem CI zu automatisieren. Auf .net kann fxCop dies tun ...

Es hängt weitgehend davon ab, welche Fehler vorliegen, wie häufig und wie schlimm sie sind und ob es sich tatsächlich um einen echten Fehler handelt oder einfach nicht, wie Sie ihn ausdrücken würden.

Ich persönlich kann es nicht ertragen, wenn ein Idiot eine 5-minütige Code-Überprüfung auf eine halbe Stunde hinauszieht, weil er möchte, dass alles so umbenannt wird, wie er es tun würde, und alle Kommentare umformuliert werden, nur weil er sein Ruder gern reinsteckt Das heißt, "Laden von Datenobjekten" muss nicht in "Die Datenobjekt-Ladekomponente lädt jetzt die relevanten Datenobjekte von der Datenobjekt-Speicherkomponente" geändert werden.

/ schimpfen :)