Laden...

Code-Review Regeln

Erstellt von Coffeebean vor 8 Jahren Letzter Beitrag vor 8 Jahren 5.642 Views
Thema geschlossen
Coffeebean Themenstarter:in
2.207 Beiträge seit 2011
vor 8 Jahren
Code-Review Regeln

Code-Review-Regeln:

1 Code muss compilieren
Niemand nützt es etwas, wenn kein compilierender Code angehängt wird. Der Code, der zum Review gestellt wird, muss in sich ohne Fehler und ausführbar sein.

1.1 "Geschlossenen" Code zur Verfügung stellen
Ein paar Zeilen "herrenlosen" Code zu posten, ist nicht Sinn dieses Forums. Bitte postet immer komplette Methoden, Klassen oder Projekte, die sich ohne weiteres Kopieren und/oder ausführen lassen.
Für ganze Projekte verwendet bitte GitHub, GitLab oder Azure DevOps (Public Repository) - oder ein ähnliches Code-Portal.
Bitte ++keine ++ganzen ZIP-Dateien anhängen oder OneDrive/DropBox verlinken.

1.2 Third-Party Libraries
Bitte prüft vor dem zur Verfügung stellen von Code von Drittanbietern, ob dies erlaubt ist, und stellt eine externe dll, die ihr benutzt, direkt zur Verfügung.

2 Wir suchen nicht eure Fehler
Um Fehler zu suchen oder nach richtiger Funktionalität zu fragen, dafür ist dieser Forenbereich der falsche Ort. Es geht hierbei um funktionierende Lösungen, die "nur" auf Stil, Umsetzung, Patterns, Best-Practices etc. untersucht werden sollen.

3 Geduld
Reviews sind sehr zeitaufwändig. Sie kosten neben der Einarbeitungszeit auch Zeit zum Lösungen Überlegen und dem Verfassen von Alternativvorschlägen. Bitte bedenkt dies beim Posten eures Codes. Je mehr Code ihr postet, desto umfangreicher kann eine Antwort werden, und desto länger kann diese dauern.

Auch hier gilt:
4 Stellt genaue Fragen
Die Frage "Wie geht das besser?" kann auf hunderte Arten beantwortet werden. Meistens ist "Anders" ein Äquivalent zu "Besser". Dies liegt fast immer im Auge des Betrachters. Stellt heraus, wo genau ihr ein Review am nötigsten haltet und wo ihr glaubt, eine andere Meinung würde euch am meisten helfen.

4.1 Gebt genug Kontext
Wenn man sich in ein Programm "eindenken" muss, ist das oft komplex. Daher gebt den Helfenden genug Kontext, schnell und ohne Umstände in das Programm einzusteigen und zu verstehen, was ihr tun wollt.

5 Lasst andere Meinungen zu
Falls ihr mehrere, vielleicht sogar verschiedene Meinungen zu eurem Code hört, überlegt euch dessen Ansatz und bewertet selber, ob dieser für euch in Frage kommt oder nicht.

Bitte beachtet immer, dass ihr am Besten wisst, was euren Code voranbringt. Alle genannten Kommentare sind allenfalls Hinweise und versuchte Hilfestellungen.

Thema geschlossen