spieleprogrammierer.de - Forum und Wiki zur Spieleprogrammierung und Spieleentwicklung

Grundsätzlich gilt für mich: Code innerhalb von Blöcken (ob nun ein Function body oder Conditionals) sollte nicht kommentiert werden, es sei denn die Implementierung ist auf einen speziellen Anwendungsfall zugeschnitten, z.B. die Verwendung eines speziellen Sortieralgorithmus, der bei den erwarteten Daten schneller fertig ist, als die Standard-Sortierimplementierung. Wobei sowas natürlich unter eine Optimierung fällt, die man erst vornehmen sollte, wenn es wirklich ein Problem gibt.

Interfaces zu eigenen Libraries/Modulen können (und sollen!) aber auf jeden Fall ausgiebig dokumentiert werden. Dazu zählen Dinge wie eventuell geworfene Exceptions, Argument Ranges, Thread Safety, etc.

Ansonsten gilt wie immer das Mantra: Good code documents itself.
Funktionen mit mehr als 20 Lines sollten selten vorkommen, bool flags als Parameter sind auch ein Unding. Generell empfehle ich als Lektüre Clean Code

Zitat von »BlueCobold«

"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.

Achso, dachte es wäre voll üblich Verhalten des Standards im code nochmal selbst zu beschreiben

Definiere "Verhalten des Standards". Was ist denn genau der "Standard"? Ich bin mir gerade nicht sicher, ob du trollst oder ob das ein ernsthafter Kommentar ist.

Ich glaube dir ist nicht ganz klar, dass ich das Beispiel nicht als positiv empfinde. Du echauffierst dich zurecht über das was da steht.
Dennoch vermittelt deine Aussage den Eindruck, als wäre sie zielgerichtet gegen mich. Deswegen dieser leicht ironische post. Mit Verhalten des Standards meinte ich hier lediglich, dass es scheinbar irgendjemand für nötig befunden hat, an dieser Stelle noch mal aufzuzählen, welche Standardfunktionen es für ein array gibt, und das diese "wahrscheinlich" schneller seien.
Das Foto ist btw aus einem WebService, das so bei uns reell im Einsatz ist. Hat mich jedenfallls belustigt.

Zusammengefasst: Ja, das war ein Troll Kommentar.

Zitat von »DNKpp«

Dennoch vermittelt deine Aussage den Eindruck, als wäre sie zielgerichtet gegen mich.

Nö, das war damit nicht gemeint. Ich habe lediglich dargelegt, warum ich das für Unfug halte und wo die Schwachpunkte sind.