Hier findest du alle Beiträge die mit dem Tag Dokumentation versehen sind.
Magic Numbers sind Zahlen (oder auch Strings), die irgendwo im Code „einfach so“ stehen und deren Bedeutung man nur errät. Du siehst dann 60, 3, 1024 oder "admin" und musst aus dem Kontext heraus rekonstruieren, warum genau dieser Wert dort steht. Zahlen im Code sind nicht per se schlecht. Schlecht wird es, wenn die Zahl eine fachliche oder technische Bedeutung trägt, diese Bedeutung aber nicht sichtbar ist.
Weiterlesen
Durch Dinge wie CleanCode oder dem KISS-Prinzip versuchen wir unseren Code möglichst verständlich zu halten. Wir benennen Methoden nachdem was sie tun, wissen, dass eine Methode auch nur eine Sache machen soll und auch die Benamung unserer Variablen sind sprechend.
Wer das alles konsequent berücksichtigt, der wird in den meisten Fällen keine Kommentare im Quelltext hinterlassen müssen – so zumindest der Wortlaut vieler Dozenten und Autoren.
In der Praxis sieht das oft aber ganz anders aus.

Hi, ich bin Marcel!
Als Fachinformatiker für Anwendungsentwicklung und IHK-geprüfter Ausbilder teile ich auf meinem Blog Grundlagen- und Fortgeschrittenen-Wissen für angehende Entwickler*innen und Interessierte, sowie weitere spannende Themen aus der IT.