spieleprogrammierer.de - Forum und Wiki zur Spieleprogrammierung und Spieleentwicklung

Sauberer Code benötigt gar keine Kommentare.

Zitat von »BlueCobold«

Sauberer Code benötigt gar keine Kommentare.

Wenn du viel optimierst, z.B. indem du Bitsets nutzt, brauchst du schon an einigen Stellen Kommentare. Oder für einige Funktionen, die Voraussetzungen (Vorbedingungen) haben, das sollte dann auch bei der Deklaration der Funktion stehen. Oder wenn Dinge wirklich kompliziert sind, helfen Kommentare, um es später besser zu verstehen.

Ich kann nur wiederholen, was ich gesagt habe. Guter Code braucht keine Kommentare (Stichwort Code-Smell). Ob Bitsets jetzt z.B. unbedingt notwendig sind und ob der Code, der mit ihnen hantiert, nun wirklich so schlecht sein sollte, dass er Kommentare benötigt, halte ich für höchst diskutabel. POITROAE wird viel zu oft ignoriert und irgendwelcher unverständlicher Unfug gebaut, obwohl nie geprofiled oder mal über die Struktur ("Funktion mit Vorbedingung" lässt grüßen) nachgedacht wurde.

Wenn eine Funktion erfordert, dass keine Mutexe gehalten werden, dann ist das eben eine Vorbedingung. Das ist auch kein schlechtes Design, sondern anders nicht lösbar, wenn du das für Multithreading optimieren willst.

Durch Bitsets spare ich ungefähr 1 bis 120 GB RAM (je nach Sichtweite). Sollte ich wohl dringend ändern, ist ja schlechter Code, weil ich dafür Kommentare brauche.

Ich denke, dass „high level“ Kommentare durchaus ihre Daseinsberechtigung haben. Beispiele:
- Man erklärt in einem Kommentar, warum man gerade Algorithmus X benutzt, wenn es für dasselbe Problem auch Algorithmus Y und Z gibt (der Programmierer weiß etwas über den typischen Anwendungsfall und basiert darauf seine Entscheidung - das kann man nur durch Lesen des Codes nicht wissen).
- Man muss "komische" Third Party-APIs aufrufen, die ungewöhnlich in der Handhabung oder Namensgebung sind (z. B. ein Kommentar wie "Diese Funktion aus der Library ... heißt zwar ..., aber was sie tatsächlich tut ist ...").
- Man ordnet Daten in einer bestimmten Reihenfolge im Speicher an, die besonders Cache-freundlich ist.
- Wenn es eigentlich eine schönere Variante gäbe, etwas zu lösen, der anvisierte Compiler ein dafür notwendiges Feature aber noch nicht unterstützt.
Nur um ein paar Beispiele zu nennen.

Zitat von »BlueCobold«

Sauberer Code benötigt gar keine Kommentare.

+1

Zitat von »David Scherfgen«

Ich denke, dass „high level“ Kommentare durchaus ihre Daseinsberechtigung haben.

+1

Zitat von »Magogan«

Sollte ich wohl dringend ändern, ist ja schlechter Code, weil ich dafür Kommentare brauche.

Wieso brauchst du dafür Kommentare?

Zitat von »David Scherfgen«

Ich denke, dass „high level“ Kommentare durchaus ihre Daseinsberechtigung haben

Ich denke dabei werden wir uns wohl auch alle einig.

sowas hier?

"sort - sort an array" - ORLY? Es wäre da sicherlich hilfreich zu wissen welcher Algorithmus dort verwendet wird oder welche Laufzeit- und Speicher-Komplexität er hat, ob er stabil ist!? Aber so ist der Kommentar reiner Code-Smell und Noise.