spieleprogrammierer.de - Forum und Wiki zur Spieleprogrammierung und Spieleentwicklung

Zitat von »babelfish«

Ich benutze Kommentare oft zur Strukturierung von Code. z.B. für jede Funktion ein Kommentar-Head.
Das gibt mir eine gute Übersicht beim scrollen durch den Quelltext.

Aber wozu bräuchte folgender Code z.B. noch Erläuterungen?

C#-Quelltext

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

// ================================================== // || OnEnemyFire protected function OnEnemyFire(enemy:SpaceIndividual) : void { if (enemy is BlueMinion || enemy is RedMinion) { var bullets:Array = enemy.Fire(); for each(var bullet:Bullet in bullets) { this.EnemyBullets.add(bullet); } } else if (enemy is PurpleMinion) { var bullets:Array = enemy.Fire(); for each(var bullet:Bullet in bullets) { FlxVelocity.moveTowardsObject(bullet, this.Player, enemy.GetBulletSpeed()); this.EnemyBullets.add(bullet); } } }

Man kann sich jetzt natürlich überlegen wie weit das mit "is" ein Fehldesign ist. Mir gefällts so

Wozu soll es gut sein, den Namen einer Funktion direkt über der Funktion noch mal hinzuschreiben? Da entzieht sich mir der Sinn. Das enthält genau 0 Information, verbraucht wertvollen Platz auf dem Bildschirm und wird beim Refactoring schnell vergessen...

Das hat rein visuell sehr wohl Sinn.

Hast du schon einmal Bejeweled gespielt? Beim Spiel geht es darum 3 oder mehr aneinander liegende, farblich gleiche Steine zu finden.
Eine Technik die oft verwendet wird, ist es, jede mögliche Farbe im Kopf durchzugehen, und die restlichen auf dem Spielfeld auszublenden.

Kommentare in den meisten IDEs sind Grün. Wenn du also etwas suchst konzentrierst du dich auf die Farbe, und kannst beim durchscrollen sehr leicht die Texte lesen.

Warum stellst du dann nicht einfach die Farbe der Funktionsbezeichner auf Grün?

weil man eventuell nicht nur einzelne Funktionen "markieren" will, sondern ggf. auch Codeabschnitte (Konstruktoren von anderen Methoden beispielsweise)
und man will vlt. nicht jede Funktion markiert haben
man kann sich so also die Kommentare nicht einfach einsparen
zudem erregen die vielen grünen Gleichheitszeichen beim Suchen die Aufmerksamkeit, wodurch man den eigentlichen grünen Text nicht so einfach übersieht

Hmm. Also ich habe in jeder IDE immer komplett eigenes Syntax-Highlighting und die Kommentare sind weniger deutlich als Klassen, Interfaces, Variablen, Zahlen, Konstanten, Operatoren und Methoden. Sogar überladene Methoden sehen bei mir anders aus als normale. Da kann mir Kommentar gestohlen bleiben, ich sehe auf einen Blick, was die Methode macht.